beads/examples/README.md
darcy f9b306f152 docs(claim): standardize start-work semantics to --claim (#2070)
Standardize start-work semantics to `bd update <id> --claim` across docs,
examples, templates, and website static LLM artifacts. Replaces
`--status in_progress` with `--claim` where the meaning is start-work.

Also fixes stale comment in llms.txt ("Update status" → "Start work").

Co-Authored-By: Valeriy Pavlovich <iqdoctor@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-24 22:11:39 -08:00

55 lines
2.2 KiB
Markdown

# Beads Examples
This directory contains examples of how to integrate bd with AI agents and workflows.
## Examples
### Agent Integration
- **[python-agent/](python-agent/)** - Simple Python agent that discovers ready work and completes tasks
- **[bash-agent/](bash-agent/)** - Bash script showing the full agent workflow
- **[startup-hooks/](startup-hooks/)** - Session startup scripts for automatic bd upgrade detection
- **[claude-desktop-mcp/](claude-desktop-mcp/)** - MCP server for Claude Desktop integration
### Tools & Utilities
- **[monitor-webui/](monitor-webui/)** - Standalone web interface for real-time issue monitoring and visualization
- **[git-hooks/](git-hooks/)** - Pre-configured git hooks for automatic Dolt sync
<!-- REMOVED (bd-4c74): branch-merge example - collision resolution no longer needed with hash IDs -->
<!-- REMOVED (bd-9ni.5): markdown-to-jsonl, github-import, jira-import converters - bd import removed; use native bd jira/linear/gitlab sync -->
### Workflow Patterns
- **[contributor-workflow/](contributor-workflow/)** - OSS contributor setup with separate planning repo
- **[team-workflow/](team-workflow/)** - Team collaboration with shared repositories
- **[multi-phase-development/](multi-phase-development/)** - Organize large projects by phases (planning, MVP, iteration, polish)
- **[multiple-personas/](multiple-personas/)** - Architect/implementer/reviewer role separation
- **[protected-branch/](protected-branch/)** - Protected branch workflow for team collaboration
## Quick Start
```bash
# 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> --claim --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.