Back to Beads

Reference

docs/reference/index.md

1.2.11.6 KB
Original Source

Lookup material for beads: the pages here specify contracts and edge cases rather than teach concepts (that's How Beads Works).

Pages in this section

  • Configuration — every config key, environment variable, default, and the precedence between them.
  • Git Integration — hooks, refs/dolt/data, role detection, and branchless (jujutsu) workflows.
  • Git Worktrees Guide — how beads behaves across worktrees sharing one repository.
  • Protected Branches — sync-branch mode for repos where direct pushes to main are blocked.
  • Advanced Features — rename, merge, compaction, and other power-user operations.
  • JSON Output Schema Contract — the stability contract behind every --json flag.
  • Events Journal — the durable, replayable record of committed mutations that external tooling tails, and its boundaries.
  • Observability (OpenTelemetry) — traces and metrics bd can emit, and how to point them at a collector.
  • Troubleshooting — symptom-first fixes for common failures (deeper runbooks live in Recovery).
  • Antivirus False Positives — Windows AV heuristics and binary verification.
  • FAQ — beads vs other trackers, and the questions everyone asks in week one.
  • CLI Reference — the generated page-per-command reference, nested below as a collapsible group.