beads/docs/cli-reference/state.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

947 B

title description
bd state Query the current value of a state dimension

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

Generated from bd help --doc state.

Query the current value of a state dimension from an issue's labels.

State labels follow the convention <dimension>:<value>, for example: patrol:active mode:degraded health:healthy

This command extracts the value for a given dimension.

Examples: bd state witness-abc patrol # Output: active bd state witness-abc mode # Output: normal bd state witness-abc health # Output: healthy

bd state <issue-id> <dimension> [flags]

bd state list

List all state labels (dimension:value format) on an issue.

This filters labels to only show those following the state convention.

Example: bd state list witness-abc

Output:

patrol: active

mode: normal

health: healthy

bd state list <issue-id> [flags]