beads/examples
2025-12-16 16:46:25 -08:00
..
bash-agent Add Agent Mail documentation and bash-agent integration 2025-11-08 01:10:20 -08:00
bd-example-extension-go Update link to EXTENDING.md in example extending README 2025-12-16 16:46:25 -08:00
claude-desktop-mcp bd sync: 2025-11-26 18:07:01 2025-11-26 18:07:01 -08:00
compaction Add comprehensive compaction documentation 2025-10-16 01:09:48 -07:00
contributor-workflow docs: update beads.jsonl references to issues.jsonl 2025-12-16 01:08:46 -08:00
git-hooks Merge GH#532 2025-12-16 01:19:14 -08:00
github-import gh2jsonl: add intra-batch collision detection for hash IDs 2025-11-25 20:33:35 -08:00
go-agent Add go.mod to go-agent example to fix goreleaser 2025-11-08 23:10:53 -08:00
jira-import fix(jira): migrate from deprecated API v2 to v3 2025-12-01 21:02:20 -08:00
library-usage test: replace manual os.Chdir with t.Chdir in tests (#457) 2025-12-04 11:21:43 -08:00
markdown-to-jsonl feat: Add markdown-to-jsonl converter example [addresses #9] 2025-10-14 13:24:20 -07:00
monitor-webui fix: use nullish coalescing to fix priority 0 bug display 2025-11-23 14:58:58 -08:00
multi-phase-development docs: fix bd daemon CLI syntax to use flag format (#568) 2025-12-15 21:16:02 -08:00
multiple-personas docs: fix bd daemon CLI syntax to use flag format (#568) 2025-12-15 21:16:02 -08:00
protected-branch Merge GH#409 2025-12-16 01:19:07 -08:00
python-agent Complete Agent Mail documentation (bd-nl8z) 2025-11-08 02:36:27 -08:00
startup-hooks feat: Add agent upgrade awareness documentation and tooling 2025-11-23 16:29:56 -08:00
team-workflow Merge GH#409 2025-12-16 01:19:07 -08:00
README.md Make beads claude code skill installable via marketplace (#468) 2025-12-13 07:15:24 -08:00

Beads Examples

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

Examples

Agent Integration

Tools & Utilities

Workflow Patterns

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.