beads/docs/cli-reference/upgrade.md
Chris Sells 4ea6fa3ac0 docs(emitter): emit Mintlify CLI reference and generated docs.json nav
bd help --docs-root now additionally writes docs/cli-reference/ in Mintlify
form (frontmatter title as H1, extensionless root-relative links, JSX
auto-generated markers since Mintlify parses .md through MDX) and rewrites
the CLI Reference pages array inside docs/docs.json via a textual splice
that leaves the rest of the file byte-identical — the ~113 nav entries are
never hand-maintained. The Docusaurus outputs (docs/CLI_REFERENCE.md,
website/docs/cli-reference/, versioned snapshots) are unchanged.

generate-cli-docs.sh --check seeds docs/docs.json and docs/cli-reference/
into its scratch root and diffs both; check-cli-docs-drift.sh adds them to
GEN_PATHSPECS and the regeneration fingerprint; docs-autofix-push.sh
allowlists the new generated paths; check-doc-flags.sh scans the new
docs/ subdirectories and requires command coverage in docs/cli-reference/.

Includes the initial docs/docs.json scaffold (nav mirrors the Docusaurus
sidebar IA) and the generated docs/cli-reference/ pages.

TDD: new emitter behavior covered in cmd/bd/help_all_test.go
(Mintlify page format, nav splice correctness + idempotence, bare-root
generation without docs.json).
2026-07-12 10:37:07 -07:00

1.7 KiB

title description
bd upgrade Check and manage bd version upgrades

{/* AUTO-GENERATED: do not edit manually */}

Generated from bd help --doc upgrade.

Commands for checking bd version upgrades and reviewing changes.

The upgrade command helps you stay aware of bd version changes:

  • bd upgrade status: Check if bd version changed since last use
  • bd upgrade review: Show what's new since your last version
  • bd upgrade ack: Acknowledge the current version

Version tracking is automatic - bd updates metadata.json on every run.

bd upgrade [flags]

bd upgrade ack

Mark the current bd version as acknowledged.

This updates metadata.json to record that you've seen the current version. Mainly useful after reviewing upgrade changes to suppress future upgrade notifications.

Note: Version tracking happens automatically, so you don't need to run this command unless you want to explicitly mark acknowledgement.

Examples: bd upgrade ack bd upgrade ack --json

bd upgrade ack [flags]

bd upgrade review

Show what's new in bd since the last version you used.

Unlike 'bd info --whats-new' which shows the last 3 versions, this command shows ALL changes since your specific last version.

If you're upgrading from an old version, you'll see the complete changelog of everything that changed since then.

Examples: bd upgrade review bd upgrade review --json

bd upgrade review [flags]

bd upgrade status

Check if bd has been upgraded since you last used it.

This command uses the version tracking that happens automatically at startup to detect if bd was upgraded.

Examples: bd upgrade status bd upgrade status --json

bd upgrade status [flags]