johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add agent warning about interactive bd edit command

Browse Source 
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>
This commit is contained in:
beads/crew/giles
2026-01-13 20:58:07 -08:00
committed by Steve Yegge
parent 53d8a1cdb6
commit ff67b88ea9
3 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
AGENTS.md
View File

@@ -20,6 +20,19 @@ This file exists for compatibility with tools that look for AGENTS.md.
See CLAUDE.md "Visual Design System" section for full guidance. See CLAUDE.md "Visual Design System" section for full guidance.
## 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) ## Landing the Plane (Session Completion)
**When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds. **When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds.

9
AGENT_INSTRUCTIONS.md
View File

@@ -191,6 +191,15 @@ bd show bd-44 --json
## Agent Session Workflow ## Agent Session Workflow
**WARNING: 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"
```
**IMPORTANT for AI agents:** When you finish making issue changes, always run: **IMPORTANT for AI agents:** When you finish making issue changes, always run:
```bash ```bash

13
cmd/bd/AGENTS.md
View File

@@ -12,6 +12,19 @@ bd close <id> # Complete work
bd sync # Sync with git 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) ## Landing the Plane (Session Completion)
**When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds. **When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds.