* 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.
125 lines
4.4 KiB
Markdown
125 lines
4.4 KiB
Markdown
---
|
|
title: CLI Reference
|
|
description: Generated reference for every bd command
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --docs-root`.
|
|
|
|
This reference covers all 108 live top-level `bd` commands. Regenerate it with:
|
|
|
|
```bash
|
|
./scripts/generate-cli-docs.sh
|
|
```
|
|
|
|
## Commands
|
|
|
|
- [`bd admin`](/cli-reference/admin)
|
|
- [`bd ado`](/cli-reference/ado)
|
|
- [`bd assign`](/cli-reference/assign)
|
|
- [`bd audit`](/cli-reference/audit)
|
|
- [`bd backup`](/cli-reference/backup)
|
|
- [`bd batch`](/cli-reference/batch)
|
|
- [`bd blocked`](/cli-reference/blocked)
|
|
- [`bd bootstrap`](/cli-reference/bootstrap)
|
|
- [`bd branch`](/cli-reference/branch)
|
|
- [`bd children`](/cli-reference/children)
|
|
- [`bd close`](/cli-reference/close)
|
|
- [`bd comment`](/cli-reference/comment)
|
|
- [`bd comments`](/cli-reference/comments)
|
|
- [`bd compact`](/cli-reference/compact)
|
|
- [`bd completion`](/cli-reference/completion)
|
|
- [`bd config`](/cli-reference/config)
|
|
- [`bd context`](/cli-reference/context)
|
|
- [`bd cook`](/cli-reference/cook)
|
|
- [`bd count`](/cli-reference/count)
|
|
- [`bd create`](/cli-reference/create)
|
|
- [`bd create-form`](/cli-reference/create-form)
|
|
- [`bd defer`](/cli-reference/defer)
|
|
- [`bd delete`](/cli-reference/delete)
|
|
- [`bd dep`](/cli-reference/dep)
|
|
- [`bd diff`](/cli-reference/diff)
|
|
- [`bd doctor`](/cli-reference/doctor)
|
|
- [`bd dolt`](/cli-reference/dolt)
|
|
- [`bd duplicate`](/cli-reference/duplicate)
|
|
- [`bd duplicates`](/cli-reference/duplicates)
|
|
- [`bd edit`](/cli-reference/edit)
|
|
- [`bd epic`](/cli-reference/epic)
|
|
- [`bd export`](/cli-reference/export)
|
|
- [`bd federation`](/cli-reference/federation)
|
|
- [`bd find-duplicates`](/cli-reference/find-duplicates)
|
|
- [`bd flatten`](/cli-reference/flatten)
|
|
- [`bd forget`](/cli-reference/forget)
|
|
- [`bd formula`](/cli-reference/formula)
|
|
- [`bd gate`](/cli-reference/gate)
|
|
- [`bd gc`](/cli-reference/gc)
|
|
- [`bd github`](/cli-reference/github)
|
|
- [`bd gitlab`](/cli-reference/gitlab)
|
|
- [`bd graph`](/cli-reference/graph)
|
|
- [`bd history`](/cli-reference/history)
|
|
- [`bd hooks`](/cli-reference/hooks)
|
|
- [`bd human`](/cli-reference/human)
|
|
- [`bd import`](/cli-reference/import)
|
|
- [`bd info`](/cli-reference/info)
|
|
- [`bd init`](/cli-reference/init)
|
|
- [`bd init-safety`](/cli-reference/init-safety)
|
|
- [`bd jira`](/cli-reference/jira)
|
|
- [`bd kv`](/cli-reference/kv)
|
|
- [`bd label`](/cli-reference/label)
|
|
- [`bd linear`](/cli-reference/linear)
|
|
- [`bd link`](/cli-reference/link)
|
|
- [`bd lint`](/cli-reference/lint)
|
|
- [`bd list`](/cli-reference/list)
|
|
- [`bd mail`](/cli-reference/mail)
|
|
- [`bd memories`](/cli-reference/memories)
|
|
- [`bd merge-slot`](/cli-reference/merge-slot)
|
|
- [`bd metrics`](/cli-reference/metrics)
|
|
- [`bd migrate`](/cli-reference/migrate)
|
|
- [`bd mol`](/cli-reference/mol)
|
|
- [`bd note`](/cli-reference/note)
|
|
- [`bd notion`](/cli-reference/notion)
|
|
- [`bd onboard`](/cli-reference/onboard)
|
|
- [`bd orphans`](/cli-reference/orphans)
|
|
- [`bd ping`](/cli-reference/ping)
|
|
- [`bd preflight`](/cli-reference/preflight)
|
|
- [`bd prime`](/cli-reference/prime)
|
|
- [`bd priority`](/cli-reference/priority)
|
|
- [`bd promote`](/cli-reference/promote)
|
|
- [`bd prune`](/cli-reference/prune)
|
|
- [`bd purge`](/cli-reference/purge)
|
|
- [`bd q`](/cli-reference/q)
|
|
- [`bd query`](/cli-reference/query)
|
|
- [`bd quickstart`](/cli-reference/quickstart)
|
|
- [`bd ready`](/cli-reference/ready)
|
|
- [`bd recall`](/cli-reference/recall)
|
|
- [`bd recompute-blocked`](/cli-reference/recompute-blocked)
|
|
- [`bd remember`](/cli-reference/remember)
|
|
- [`bd rename`](/cli-reference/rename)
|
|
- [`bd rename-prefix`](/cli-reference/rename-prefix)
|
|
- [`bd reopen`](/cli-reference/reopen)
|
|
- [`bd repo`](/cli-reference/repo)
|
|
- [`bd restore`](/cli-reference/restore)
|
|
- [`bd rules`](/cli-reference/rules)
|
|
- [`bd search`](/cli-reference/search)
|
|
- [`bd set-state`](/cli-reference/set-state)
|
|
- [`bd setup`](/cli-reference/setup)
|
|
- [`bd ship`](/cli-reference/ship)
|
|
- [`bd show`](/cli-reference/show)
|
|
- [`bd sql`](/cli-reference/sql)
|
|
- [`bd stale`](/cli-reference/stale)
|
|
- [`bd state`](/cli-reference/state)
|
|
- [`bd status`](/cli-reference/status)
|
|
- [`bd statuses`](/cli-reference/statuses)
|
|
- [`bd supersede`](/cli-reference/supersede)
|
|
- [`bd swarm`](/cli-reference/swarm)
|
|
- [`bd tag`](/cli-reference/tag)
|
|
- [`bd todo`](/cli-reference/todo)
|
|
- [`bd types`](/cli-reference/types)
|
|
- [`bd undefer`](/cli-reference/undefer)
|
|
- [`bd update`](/cli-reference/update)
|
|
- [`bd upgrade`](/cli-reference/upgrade)
|
|
- [`bd vc`](/cli-reference/vc)
|
|
- [`bd version`](/cli-reference/version)
|
|
- [`bd where`](/cli-reference/where)
|
|
- [`bd worktree`](/cli-reference/worktree)
|