ff67b88ea9
The bd edit command opens an interactive editor ($EDITOR) which AI agents cannot use. Added warnings to AGENTS.md, AGENT_INSTRUCTIONS.md, and cmd/bd/AGENTS.md directing agents to use bd update with flags instead. Fixes: bd-3ft33 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
54 lines
1.7 KiB
Markdown
54 lines
1.7 KiB
Markdown
# Agent Instructions
|
|
|
|
This project uses **bd** (beads) for issue tracking. Run `bd onboard` to get started.
|
|
|
|
## Quick Reference
|
|
|
|
```bash
|
|
bd ready # Find available work
|
|
bd show <id> # View issue details
|
|
bd update <id> --status in_progress # Claim work
|
|
bd close <id> # Complete work
|
|
bd sync # Sync with git
|
|
```
|
|
|
|
## 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
|
|
bd sync
|
|
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
|
|
|