mirror of
https://github.com/gastownhall/beads.git
synced 2026-09-14 20:17:24 +08:00
Chris Sells
d2f87d50de
* docs(pipeline): pin the generated CLI docs to the released bd; repair main's CLI reference The #4874 squash-merge raced the docs-autofix bot: the bot had pushed a regeneration from main's source onto the PR branch, so the squash landed a contradictory mix — the release-aligned hand-written docs plus a CLI reference re-documenting unreleased commands and flags, with docs.json referencing four pages (heartbeat, migrate-personal, reclaim, unclaim) whose files do not exist. That broken nav fails the docsync guard on main and on every branch cut from it. This restores the intended end state of #4874 and lands the pin that prevents the race from recurring. - Regenerate the CLI reference from a bd built from the v1.1.0 tag (CI's canonical pure-Go build), removing the unreleased commands/flags and fixing the dangling nav entries. - docs/cli-docs.pin names the release tag; scripts/resolve-docs-bd.sh builds and caches a canonical pure-Go bd from that tag, fetching the tag first in shallow CI checkouts. - generate-cli-docs.sh, check-doc-flags.sh, and check-cli-docs-drift.sh resolve bd through the pin and ignore a supplied binary while pinned (BD_DOCS_IGNORE_PIN=1 bypasses), so the drift gates and the autofix bot now enforce docs-match-release instead of docs-match-main. - tools/docsmint detects the pre-overhaul Docusaurus staging layout that bd <= v1.1.0 emits and converts it to the generic form before its normal Mintlify transform (tested); removable once the pin reaches a release whose emitter writes build/cli-docs. - check-doc-flags.sh: run without timeout(1) on macOS instead of failing Check 4. - Decision record: engdocs/decisions/2026-07-17-docs-release-pin.md; the beads-docs skill §8 updated to match. * lint: annotate gosec G705 false positive in the docsmint legacy bridge Same class as the existing nav-splice annotation: a developer tool writing repo Markdown, not a web-output sink.
134 lines
2.6 KiB
Markdown
134 lines
2.6 KiB
Markdown
---
|
|
title: "bd completion"
|
|
description: "Generate the autocompletion script for bd 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
|
|
```
|