beads/examples
spm1001 69e8fb1f6d
Update Claude Code skill with compaction survival, enhanced TodoWrite integration, and CLI docs (#85)
Thanks for accepting the original contribution! I've made some updates based on
real-world usage.

Some of the examples in the original were a bit idiosyncratic to my own work,
so I've generalized them to use universal programming scenarios (authentication,
database migrations, API design) that should be more relatable to any developer.

I've also added some broader improvements to the skill. Apologies for not doing
these as two separate pull requests - I hope bundling them together is OK.

These improvements came largely from asking Claude to reflect on what was useful
and difficult about using the skill - in particular, Claude felt that the
post-compaction scenario was a powerful one because normally a context compaction
causes severe loss of state.

Main changes:
- Add comprehensive compaction survival guide with note-taking patterns
- Replace basic TodoWrite integration with temporal layering pattern
- Add bd export/import documentation with collision resolution
- Clarify when to ask before creating issues vs creating directly
- Add database discovery rules for multi-DB scenarios
2025-10-19 09:33:24 -07:00
..
bash-agent Prepare for public launch: comprehensive examples, docs, and tooling 2025-10-12 11:25:29 -07:00
bd-example-extension-go feat: Remove CGO dependency by migrating to pure Go SQLite driver 2025-10-14 11:20:27 -07:00
branch-merge Add collision resolution with automatic ID remapping 2025-10-12 17:13:09 -07:00
claude-code-skill Update Claude Code skill with compaction survival, enhanced TodoWrite integration, and CLI docs (#85) 2025-10-19 09:33:24 -07:00
claude-desktop-mcp feat(mcp): Setup beads-mcp for PyPI distribution 2025-10-14 18:07:22 -07:00
compaction Add comprehensive compaction documentation 2025-10-16 01:09:48 -07:00
git-hooks Implement auto-import to complete automatic git sync workflow 2025-10-13 22:48:30 -07:00
github-import Add GitHub Issues migration script (bd-68) 2025-10-17 23:55:51 -07:00
markdown-to-jsonl feat: Add markdown-to-jsonl converter example [addresses #9] 2025-10-14 13:24:20 -07:00
python-agent Prepare for public launch: comprehensive examples, docs, and tooling 2025-10-12 11:25:29 -07:00
README.md Add Claude Code skill for beads usage 2025-10-18 17:54:46 +01:00

Beads Examples

This directory contains examples of how to integrate bd with AI agents and workflows.

Examples

Quick Start

# Try the Python agent example
cd python-agent
python agent.py

# Try the bash agent example
cd bash-agent
./agent.sh

# Install git hooks
cd git-hooks
./install.sh

# Try branch merge collision resolution
cd branch-merge
./demo.sh

Creating Your Own Agent

The basic agent workflow:

  1. Find ready work: bd ready --json --limit 1
  2. Claim the task: bd update <id> --status in_progress --json
  3. Do the work: Execute the task
  4. Discover new issues: bd create "Found bug" --json
  5. Link discoveries: bd dep add <new-id> <parent-id> --type discovered-from
  6. Complete the task: bd close <id> --reason "Done" --json

All commands support --json for easy parsing.