beads/examples
2025-11-06 15:00:15 -08:00
..
bash-agent Prepare for public launch: comprehensive examples, docs, and tooling 2025-10-12 11:25:29 -07:00
bd-example-extension-go Reorganize project structure: move Go files to internal/beads, docs to docs/ 2025-11-05 21:04:00 -08:00
claude-code-skill Implement BEADS_DIR environment variable (bd-e16b) 2025-11-02 18:36:30 -08: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
contributor-workflow feat: Add bd init --contributor and --team wizards 2025-11-05 19:04:14 -08:00
git-hooks Add git hooks support and refactor info command 2025-11-06 15:00:15 -08:00
github-import Remove collision-era language from docs and code 2025-10-31 14:24:50 -07:00
library-usage Reorganize project structure: move Go files to internal/beads, docs to docs/ 2025-11-05 21:04:00 -08:00
markdown-to-jsonl feat: Add markdown-to-jsonl converter example [addresses #9] 2025-10-14 13:24:20 -07:00
multi-phase-development Add workflow examples: multi-phase development and multiple personas (bd-p68x) 2025-11-05 19:12:58 -08:00
multiple-personas Add workflow examples: multi-phase development and multiple personas (bd-p68x) 2025-11-05 19:12:58 -08:00
protected-branch Add comprehensive protected branch workflow documentation (bd-5ce8) 2025-11-02 18:41:51 -08:00
python-agent Prepare for public launch: comprehensive examples, docs, and tooling 2025-10-12 11:25:29 -07:00
team-workflow feat: Add bd init --contributor and --team wizards 2025-11-05 19:04:14 -08:00
README.md Add workflow examples: multi-phase development and multiple personas (bd-p68x) 2025-11-05 19:12:58 -08: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

# REMOVED (bd-4c74): branch-merge demo - hash IDs eliminate collision resolution

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.