| name | beads |
| description | Use when working on projects that use 'beads' (bd) for issue tracking. Covers bd commands, workflow, priorities, and best practices for AI agents. |
Issue Tracking with bd (beads)
IMPORTANT: Projects using beads require bd for ALL issue tracking. Do NOT use markdown TODOs, task lists, or other tracking methods.
Why bd?
- Dependency-aware: Track blockers and relationships between issues
- Git-friendly: Auto-syncs to JSONL for version control
- Agent-optimized: JSON output, ready work detection, discovered-from links
- Prevents duplicate tracking systems and confusion
Quick Start
Check for ready work:
bd ready --json
Create new issues:
bd create "Issue title" -t bug|feature|task -p 0-4 --json
bd create "Issue title" -p 1 --deps discovered-from:bd-123 --json
Claim and update:
bd update bd-42 --status in_progress --json
bd update bd-42 --priority 1 --json
Complete work:
bd close bd-42 --reason "Completed" --json
Issue Types
bug- Something brokenfeature- New functionalitytask- Work item (tests, docs, refactoring)epic- Large feature with subtaskschore- Maintenance (dependencies, tooling)
Priorities
0- Critical (security, data loss, broken builds)1- High (major features, important bugs)2- Medium (default, nice-to-have)3- Low (polish, optimization)4- Backlog (future ideas)
Workflow for AI Agents
- Check ready work:
bd readyshows unblocked issues - Claim your task:
bd update <id> --status in_progress - Work on it: Implement, test, document
- Discover new work? Create linked issue:
bd create "Found bug" -p 1 --deps discovered-from:<parent-id>
- Complete:
bd close <id> --reason "Done" - Commit together: Always commit the
.beads/issues.jsonlfile together with the code changes so issue state stays in sync with code state
Auto-Sync
bd automatically syncs with git:
- Exports to
.beads/issues.jsonlafter changes (5s debounce) - Imports from JSONL when newer (e.g., after
git pull) - No manual export/import needed!
Managing AI-Generated Planning Documents
AI assistants often create planning and design documents during development. Best Practice: Use a dedicated history/ directory for these ephemeral files to keep the repository root clean.
Important Rules
- Use bd for ALL task tracking in beads-enabled projects
- Always use
--jsonflag for programmatic use - Link discovered work with
discovered-fromdependencies - Check
bd readybefore asking "what should I work on?" - Store AI planning docs in
history/directory - Do NOT create markdown TODO lists
- Do NOT duplicate tracking systems
- Do NOT clutter repo root with planning documents