beads/docs/cli-reference/completion.md
Chris Sells 4ea6fa3ac0 docs(emitter): emit Mintlify CLI reference and generated docs.json nav
bd help --docs-root now additionally writes docs/cli-reference/ in Mintlify
form (frontmatter title as H1, extensionless root-relative links, JSX
auto-generated markers since Mintlify parses .md through MDX) and rewrites
the CLI Reference pages array inside docs/docs.json via a textual splice
that leaves the rest of the file byte-identical — the ~113 nav entries are
never hand-maintained. The Docusaurus outputs (docs/CLI_REFERENCE.md,
website/docs/cli-reference/, versioned snapshots) are unchanged.

generate-cli-docs.sh --check seeds docs/docs.json and docs/cli-reference/
into its scratch root and diffs both; check-cli-docs-drift.sh adds them to
GEN_PATHSPECS and the regeneration fingerprint; docs-autofix-push.sh
allowlists the new generated paths; check-doc-flags.sh scans the new
docs/ subdirectories and requires command coverage in docs/cli-reference/.

Includes the initial docs/docs.json scaffold (nav mirrors the Docusaurus
sidebar IA) and the generated docs/cli-reference/ pages.

TDD: new emitter behavior covered in cmd/bd/help_all_test.go
(Mintlify page format, nav splice correctness + idempotence, bare-root
generation without docs.json).
2026-07-12 10:37:07 -07:00

2.6 KiB

title description
bd completion Generate the autocompletion script for the specified shell

{/* AUTO-GENERATED: do not edit manually */}

Generated from bd help --doc completion.

Generate the autocompletion script for bd for the specified shell. See each sub-command's help for details on how to use the generated script.

bd completion [flags]

bd completion bash

Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

source <(bd completion bash)

To load completions for every new session, execute once:

Linux:

bd completion bash > /etc/bash_completion.d/bd

macOS:

bd completion bash > $(brew --prefix)/etc/bash_completion.d/bd

You will need to start a new shell for this setup to take effect.

bd completion bash

Flags:

      --no-descriptions   disable completion descriptions

bd completion fish

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

bd completion fish | source

To load completions for every new session, execute once:

bd completion fish > ~/.config/fish/completions/bd.fish

You will need to start a new shell for this setup to take effect.

bd completion fish [flags]

Flags:

      --no-descriptions   disable completion descriptions

bd completion powershell

Generate the autocompletion script for powershell.

To load completions in your current shell session:

bd completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command to your powershell profile.

bd completion powershell [flags]

Flags:

      --no-descriptions   disable completion descriptions

bd completion zsh

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

source <(bd completion zsh)

To load completions for every new session, execute once:

Linux:

bd completion zsh > "${fpath[1]}/_bd"

macOS:

bd completion zsh > $(brew --prefix)/share/zsh/site-functions/_bd

You will need to start a new shell for this setup to take effect.

bd completion zsh [flags]

Flags:

      --no-descriptions   disable completion descriptions