beads/website/docs/cli-reference/set-state.md
matt wilkie b2a4d1d04a
docs: generate CLI reference from live help (#3704)
* docs: generate CLI reference from live help

* docs(cli): move bd version stamp from per-command pages to index only

Drops the `(bd version X.Y.Z)` suffix from the auto-generated header on
every per-command CLI reference page (writeSingleCommandDoc) and the
docs/CLI_REFERENCE.md preamble (writeAllHelp). The version label now
lives only on the index page emitted by scripts/generate-cli-docs.sh:

- Dev tree (website/docs/cli-reference/index.md, docs/CLI_REFERENCE.md):
  labelled "Latest"
- Versioned snapshots (website/versioned_docs/version-X.Y.Z/...):
  labelled with the explicit semver tag parsed from the directory name

This eliminates the 100+-file no-signal diff a release version bump
otherwise produces, restoring the "regen as a separate small commit"
workflow PR #3704 enables. After this change a version bump alone
yields zero diff on the dev tree; only the new versioned snapshot
created at release-cut time carries the new tag. No datestamps are
introduced anywhere — scripts/generate-cli-docs.sh --check remains
deterministic across CI runs.

Refs: mybd-afb, PR #3704

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: CI Bot <ci@beads.test>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 19:43:49 -07:00

1 KiB

id title slug sidebar_position
set-state bd set-state /cli-reference/set-state 999

Generated from bd help --doc set-state

bd set-state

Atomically set operational state on an issue.

This command:

  1. Creates an event bead recording the state change (source of truth)
  2. Removes any existing label for the dimension
  3. Adds the new dimension:value label (fast lookup cache)

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

Examples: bd set-state agent-abc patrol=muted --reason "Investigating stuck worker" bd set-state agent-abc mode=degraded --reason "High error rate detected" bd set-state agent-abc health=healthy

The --reason flag provides context for the event bead (recommended).

bd set-state <issue-id> <dimension>=<value> [flags]

Flags:

      --reason string   Reason for the state change (recorded in event)