|
| 1 | +--- |
| 2 | +name: beads |
| 3 | +description: Issue tracking with Beads (br/bv). Use when working with tasks, bugs, issues, or needing to triage work priorities. |
| 4 | +--- |
| 5 | + |
| 6 | +# Issue Tracking with br (Beads) |
| 7 | + |
| 8 | +All issue tracking goes through **Beads**. No other TODO systems. |
| 9 | + |
| 10 | +**Note:** `br` is a convenience alias for the real Beads CLI: `bd`. |
| 11 | + |
| 12 | +## Key Invariants |
| 13 | + |
| 14 | +- `.beads/` is authoritative state and **must always be committed** with code changes. |
| 15 | +- Do not edit `.beads/*.jsonl` directly; only via `br` / `bd`. |
| 16 | + |
| 17 | +## Basic Commands |
| 18 | + |
| 19 | +```bash |
| 20 | +br ready --json # Check ready work |
| 21 | +br create "Title" -t bug -p 1 # Create issue (types: bug|feature|task|epic|chore) |
| 22 | +br update br-42 --status in_progress |
| 23 | +br close br-42 --reason "Done" |
| 24 | +br sync --flush-only # Export without git ops |
| 25 | +``` |
| 26 | + |
| 27 | +**Priorities:** `0` critical | `1` high | `2` medium | `3` low | `4` backlog |
| 28 | + |
| 29 | +## Agent Workflow |
| 30 | + |
| 31 | +1. `br ready` → find unblocked work |
| 32 | +2. `br update <id> --status in_progress` → claim |
| 33 | +3. Implement + test |
| 34 | +4. If new work found → `br create ... --deps discovered-from:<id>` |
| 35 | +5. `br close <id>` → complete |
| 36 | +6. Commit `.beads/` with code changes |
| 37 | + |
| 38 | +--- |
| 39 | + |
| 40 | +# bv — Beads Viewer (AI Sidecar) |
| 41 | + |
| 42 | +Graph-aware triage engine with precomputed metrics (PageRank, betweenness, critical path). |
| 43 | + |
| 44 | +**⚠️ CRITICAL: Use ONLY `--robot-*` flags. Bare `bv` launches TUI that blocks your session.** |
| 45 | + |
| 46 | +## Core Commands |
| 47 | + |
| 48 | +```bash |
| 49 | +bv --robot-triage # THE MEGA-COMMAND: start here |
| 50 | +bv --robot-next # Single top pick + claim command |
| 51 | +bv --robot-plan # Parallel execution tracks |
| 52 | +bv --robot-priority # Priority misalignment detection |
| 53 | +``` |
| 54 | + |
| 55 | +## Triage Output |
| 56 | + |
| 57 | +Returns: `quick_ref`, `recommendations`, `quick_wins`, `blockers_to_clear`, `project_health`, `commands` |
| 58 | + |
| 59 | +## Graph Analysis |
| 60 | + |
| 61 | +| Command | Returns | |
| 62 | +|---------|---------| |
| 63 | +| `--robot-insights` | PageRank, betweenness, HITS, cycles, critical path | |
| 64 | +| `--robot-label-health` | Per-label health levels | |
| 65 | +| `--robot-label-flow` | Cross-label dependencies | |
| 66 | +| `--robot-alerts` | Stale issues, blocking cascades | |
| 67 | + |
| 68 | +## Filtering |
| 69 | + |
| 70 | +```bash |
| 71 | +bv --robot-plan --label backend |
| 72 | +bv --recipe actionable --robot-triage |
| 73 | +bv --robot-triage --robot-triage-by-label |
| 74 | +``` |
| 75 | + |
| 76 | +## jq Examples |
| 77 | + |
| 78 | +```bash |
| 79 | +bv --robot-triage | jq '.quick_ref' |
| 80 | +bv --robot-triage | jq '.recommendations[0]' |
| 81 | +bv --robot-insights | jq '.Cycles' |
| 82 | +``` |
| 83 | + |
| 84 | +**Note:** Phase 1 (degree, topo sort) is instant. Phase 2 (PageRank, betweenness) has 500ms timeout. |
0 commit comments