Files
beads/commands/workflow.md
Steve Yegge f755472410 fix: Remove unsupported env vars and fix slash commands directory structure
Fixes #42 and #44

- Remove BEADS_ACTOR and BEADS_WORKING_DIR from plugin.json env
  (Claude Code only supports ${CLAUDE_PLUGIN_ROOT} expansion)
- Move commands from .claude-plugin/commands/ to commands/ at root
- Rename command files to remove redundant bd- prefix

This fixes MCP server crashes with literal ${PWD} directory errors
and makes slash commands discoverable in Claude Code.

Amp-Thread-ID: https://ampcode.com/threads/T-69426d6c-25ea-4333-8955-5b624001c8c6
Co-authored-by: Amp <amp@ampcode.com>
2025-10-15 12:47:21 -07:00

2.0 KiB

description
description
Show the AI-supervised issue workflow guide

Display the beads workflow for AI agents and developers.

Beads Workflow

Beads is an issue tracker designed for AI-supervised coding workflows. Here's how to use it effectively:

1. Find Ready Work

Use /bd-ready or the ready MCP tool to see tasks with no blockers.

2. Claim Your Task

Update the issue status to in_progress:

  • Via command: /bd-update <id> in_progress
  • Via MCP tool: update with status: "in_progress"

3. Work on It

Implement, test, and document the feature or fix.

4. Discover New Work

As you work, you'll often find bugs, TODOs, or related work:

  • Create issues: /bd-create or create MCP tool
  • Link them: Use dep MCP tool with type: "discovered-from"
  • This maintains context and work history

5. Complete the Task

Close the issue when done:

  • Via command: /bd-close <id> "Completed: <summary>"
  • Via MCP tool: close with reason

6. Check What's Unblocked

After closing, check if other work became ready:

  • Use /bd-ready to see newly unblocked tasks
  • Start the cycle again

Tips

  • Priority levels: 0=critical, 1=high, 2=medium, 3=low, 4=backlog
  • Issue types: bug, feature, task, epic, chore
  • Dependencies: Use blocks for hard dependencies, related for soft links
  • Auto-sync: Changes automatically export to .beads/issues.jsonl (5-second debounce)
  • Git workflow: After git pull, JSONL auto-imports if newer than DB

Available Commands

  • /bd-ready - Find unblocked work
  • /bd-create - Create new issue
  • /bd-show - Show issue details
  • /bd-update - Update issue
  • /bd-close - Close issue
  • /bd-workflow - Show this guide (you are here!)

MCP Tools Available

Use these via the beads MCP server:

  • ready, list, show, create, update, close
  • dep (manage dependencies), blocked, stats
  • init (initialize bd in a project)

For more details, see the beads README at: https://github.com/steveyegge/beads