* docs: generate CLI reference from live help * docs(cli): move bd version stamp from per-command pages to index only Drops the `(bd version X.Y.Z)` suffix from the auto-generated header on every per-command CLI reference page (writeSingleCommandDoc) and the docs/CLI_REFERENCE.md preamble (writeAllHelp). The version label now lives only on the index page emitted by scripts/generate-cli-docs.sh: - Dev tree (website/docs/cli-reference/index.md, docs/CLI_REFERENCE.md): labelled "Latest" - Versioned snapshots (website/versioned_docs/version-X.Y.Z/...): labelled with the explicit semver tag parsed from the directory name This eliminates the 100+-file no-signal diff a release version bump otherwise produces, restoring the "regen as a separate small commit" workflow PR #3704 enables. After this change a version bump alone yields zero diff on the dev tree; only the new versioned snapshot created at release-cut time carries the new tag. No datestamps are introduced anywhere — scripts/generate-cli-docs.sh --check remains deterministic across CI runs. Refs: mybd-afb, PR #3704 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: CI Bot <ci@beads.test> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
136 lines
2.6 KiB
Markdown
136 lines
2.6 KiB
Markdown
---
|
|
id: completion
|
|
title: bd completion
|
|
slug: /cli-reference/completion
|
|
sidebar_position: 999
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
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
|
|
```
|
|
|
|
### 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
|
|
```
|