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.
5.9 KiB
5.9 KiB
| title | description |
|---|---|
| CLI Reference | Generated reference for every bd command |
{/* AUTO-GENERATED: do not edit manually */}
Generated from bd help --docs-root.
This reference covers all 112 live top-level bd commands. Regenerate it with:
./scripts/generate-cli-docs.sh
Global Flags
These flags apply to all commands:
--actor string Actor name for audit trail (default: $BEADS_ACTOR, git user.name, $USER)
--db string Database path (default: auto-discover .beads/*.db)
-C, --directory string Change to this directory before running the command (like git -C)
--dolt-auto-commit string Dolt auto-commit policy (off|on|batch). 'on': commit after each write. 'batch': defer commits to bd dolt commit; uncommitted changes persist in the working set until then. SIGTERM/SIGHUP flush pending batch commits. Default: off. Override via config key dolt.auto-commit
--global Use the global shared-server database (beads_global)
--ignore-schema-skew Proceed despite forward schema drift (some queries may fail)
--json Output in JSON format
--profile Generate CPU profile for performance analysis
-q, --quiet Suppress non-essential output (errors only)
--readonly Read-only mode: block write operations (for worker sandboxes)
--sandbox Sandbox mode: disables Dolt auto-push
-v, --verbose Enable verbose/debug output
Commands
bd adminbd adobd assignbd auditbd backupbd batchbd blockedbd bootstrapbd branchbd childrenbd closebd commentbd commentsbd compactbd completionbd configbd contextbd cookbd countbd createbd create-formbd deferbd deletebd depbd diffbd doctorbd doltbd duplicatebd duplicatesbd editbd epicbd exportbd federationbd find-duplicatesbd flattenbd forgetbd formulabd gatebd gcbd githubbd gitlabbd graphbd heartbeatbd historybd hooksbd humanbd importbd infobd initbd init-safetybd jirabd kvbd labelbd linearbd linkbd lintbd listbd mailbd memoriesbd merge-slotbd metricsbd migratebd migrate-personalbd molbd notebd notionbd onboardbd orphansbd pingbd preflightbd primebd prioritybd promotebd prunebd purgebd qbd querybd quickstartbd readybd recallbd reclaimbd recompute-blockedbd rememberbd renamebd rename-prefixbd reopenbd repobd restorebd rulesbd searchbd set-statebd setupbd shipbd showbd sqlbd stalebd statebd statusbd statusesbd supersedebd swarmbd tagbd todobd typesbd unclaimbd undeferbd updatebd upgradebd vcbd versionbd wherebd worktree