7f93a602d2
- Provides comprehensive workflow patterns and decision criteria - Includes quick reference (SKILL.md) and detailed references - Teaches when to use bd vs markdown/TodoWrite - Covers dependency types and issue lifecycle management - Complements existing plugin with usage philosophy
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
# Beads Examples
|
|
|
|
This directory contains examples of how to integrate bd with AI agents and workflows.
|
|
|
|
## Examples
|
|
|
|
- **[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
|
|
- **[markdown-to-jsonl/](markdown-to-jsonl/)** - Convert markdown planning docs to bd issues
|
|
- **[github-import/](github-import/)** - Import issues from GitHub repositories
|
|
- **[git-hooks/](git-hooks/)** - Pre-configured git hooks for automatic export/import
|
|
- **[branch-merge/](branch-merge/)** - Branch merge workflow with collision resolution
|
|
- **[claude-desktop-mcp/](claude-desktop-mcp/)** - MCP server for Claude Desktop integration
|
|
- **[claude-code-skill/](claude-code-skill/)** - Claude Code skill for effective beads usage patterns
|
|
|
|
## 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
|
|
|
|
# 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.
|