beads/docs/cli-reference/index.md
matt wilkie 00107e6ed5 docs: regenerate CLI reference for global --no-color flag
Agent-Signature: claude-fable-5-high on behalf of maphew
2026-07-13 20:54:50 -07:00

6 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
      --no-color                  Disable color output (also: NO_COLOR=1 or CLICOLOR=0)
      --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