beads/website/docs/cli-reference/completion.md
matt wilkie dfa8ea4813
fix(docgen): generate CLI docs in one process (#4474)
Add a bulk help docs writer that emits the root CLI reference and website command pages from a single Cobra walk. Update the shell generator to call that mode, preserve the pure-Go docs binary guard, and refresh historical versioned CLI docs only when release snapshotting requests a specific version.

Agent-Signature: codex-gpt-5.5-medium on behalf of matt wilkie
2026-06-22 18:25:58 -07:00

2.6 KiB

id title slug sidebar_position
completion bd completion /cli-reference/completion 999

Generated from bd help --doc completion

bd 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