beads/docs/cli-reference/upgrade.md
Chris Sells de0200ff77 docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard
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.
2026-07-12 10:37:17 -07:00

73 lines
1.7 KiB
Markdown

---
title: "bd upgrade"
description: "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 [command]
```
## 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]
```