beads/docs/cli-reference/completion.md
Chris Sells de0200ff77 docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard
Three generated-content defects from the adversarial review, all
structurally invisible to the drift gate (generated-vs-generated):

- Usage lines now mirror Cobra's help template: a runnable command shows
  its UseLine, a command with subcommands shows '<path> [command]', both
  when both apply. Previously bare UseLine() stamped 'bd mol [flags]' on
  30 parent pages — a line the binary never prints.
- The generated CLI index publishes the Global Flags block; the binary
  prints it on every --help but no page carried it.
- docsmint neutralizes prose lines that Mintlify's prebuild would dedent
  into MDX ESM blocks (a line beginning 'export'/'import' outside a
  fence gets wrapped in a code span). This is why /cli-reference/mail
  returned HTTP 200 while rendering only a parse-error placeholder —
  reproduced, fixed, and covered by a planted-hazard test; fenced
  content stays verbatim.

Also rewords check-cli-docs-drift.sh's early-PASS message, which
asserted 'the supplied binary differs' as the cause when uncommitted
local edits produce the same result.

All 113 pages + docs/CLI_REFERENCE.md regenerated through the pipeline;
TDD'd in cmd/bd/help_all_test.go and tools/docsmint/docsmint_test.go.
Verified live: /cli-reference/mail renders real content, zero parse
errors; generate-cli-docs.sh --check, docsync, freshness, and
mint broken-links all pass on this tree.
2026-07-12 10:37:17 -07:00

133 lines
2.6 KiB
Markdown

---
title: "bd completion"
description: "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 [command]
```
## 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 &lt;(bd completion bash)
To load completions for every new session, execute once:
#### Linux:
bd completion bash &gt; /etc/bash_completion.d/bd
#### macOS:
bd completion bash &gt; $(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 &gt; ~/.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" &gt;&gt; ~/.zshrc
To load completions in your current shell session:
source &lt;(bd completion zsh)
To load completions for every new session, execute once:
#### Linux:
bd completion zsh &gt; "$&#123;fpath[1]&#125;/_bd"
#### macOS:
bd completion zsh &gt; $(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
```