Files

matt wilkie e01b7412d9 feat: add Git worktree compatibility (PR #478 )

Adds comprehensive Git worktree support for beads issue tracking:

Core changes:
- New internal/git/gitdir.go package for worktree detection
- GetGitDir() returns proper .git location (main repo, not worktree)
- Updated all hooks to use git.GetGitDir() instead of local helper
- BeadsDir() now prioritizes main repository's .beads directory

Features:
- Hooks auto-install in main repo when run from worktree
- Shared .beads directory across all worktrees
- Config option no-install-hooks to disable auto-install
- New bd worktree subcommand for diagnostics

Documentation:
- New docs/WORKTREES.md with setup instructions
- Updated CHANGELOG.md and AGENT_INSTRUCTIONS.md

Testing:
- Updated tests to use exported git.GetGitDir()
- Added worktree detection tests

Co-authored-by: Claude <noreply@anthropic.com>
Closes: #478

2025-12-13 12:50:33 -08:00

2.0 KiB

Raw Blame History

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

2.0 KiB Raw Blame History