beads/cmd/bd/AGENTS.md
Kevin Glynn 8b2f21745f
docs: fix stale agent instructions across 5 files (#3436)
Fix stale agent-facing documentation for Dolt-only storage, build/test commands, claiming work, and removed references. Includes maintainer cleanup to align remaining stale test guidance with the current make test / test-icu-path policy.\n\nCo-authored-by: Kevin Glynn <12972584+kevglynn@users.noreply.github.com>\nCo-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-25 11:45:39 -07:00

58 lines
2.1 KiB
Markdown

# Agent Instructions
This project uses **bd** (beads) for issue tracking. Run `bd prime` for full workflow context.
## Quick Reference
```bash
bd ready # Find available work (open, no blockers)
bd blocked # Show blocked issues and what blocks them
bd list # List all issues (with blocker annotations)
bd show <id> # View issue details
bd update <id> --claim # Claim work (atomic compare-and-swap)
bd close <id> # Complete work
bd dolt push # Push to Dolt remote
```
**Dependency status**: `bd ready` and `bd blocked` are the authoritative
sources for whether work is blocked. `bd list` shows active blocker
annotations but use `bd ready`/`bd blocked` for accurate blocking status.
## Agent Warning: Interactive Commands
**DO NOT use `bd edit`** - it opens an interactive editor ($EDITOR) which AI agents cannot use.
Use `bd update` with flags instead:
```bash
bd update <id> --description "new description"
bd update <id> --title "new title"
bd update <id> --design "design notes"
bd update <id> --notes "additional notes"
bd update <id> --acceptance "acceptance criteria"
```
## Landing the Plane (Session Completion)
**When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds.
**MANDATORY WORKFLOW:**
1. **File issues for remaining work** - Create issues for anything that needs follow-up
2. **Run quality gates** (if code changed) - Tests, linters, builds
3. **Update issue status** - Close finished work, update in-progress items
4. **PUSH TO REMOTE** - This is MANDATORY:
```bash
git pull --rebase
git push
git status # MUST show "up to date with origin"
```
5. **Clean up** - Clear stashes, prune remote branches
6. **Verify** - All changes committed AND pushed
7. **Hand off** - Provide context for next session
**CRITICAL RULES:**
- Work is NOT complete until `git push` succeeds
- NEVER stop before pushing - that leaves work stranded locally
- NEVER say "ready to push when you are" - YOU must push
- If push fails, resolve and retry until it succeeds