1cc238f61d
Implements bd-hwmp and bd-5otr (part of epic bd-nxgk) to help AI agents automatically detect and adapt to bd upgrades. ## Changes ### Documentation (bd-hwmp) - Added "After Upgrading bd" section to AGENTS.md with step-by-step workflow - Enhanced "Pro Tips for Agents" with upgrade detection guidance - Documents bd info --whats-new and bd hooks install commands - References GitHub Discussion #239 ### Startup Hook (bd-5otr) - Created examples/startup-hooks/bd-version-check.sh - Auto-detects bd version changes via .beads/metadata.json - Shows bd info --whats-new when upgrade detected - Auto-updates outdated git hooks - Handles edge cases (no jq, not in beads project, etc.) - Created examples/startup-hooks/README.md with integration examples - Claude Code, GitHub Copilot, Cursor integration patterns - Comprehensive usage and troubleshooting guide - Updated examples/README.md with new startup-hooks section ## Impact Agents can now: - Automatically detect bd upgrades at session start - See what changed without re-reading all documentation - Keep git hooks in sync automatically - Adapt workflows based on new features Works today with zero bd code changes required! Related: #239 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
59 lines
2.5 KiB
Markdown
59 lines
2.5 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
|
|
- **[AGENT_MAIL_EXAMPLE.md](python-agent/AGENT_MAIL_EXAMPLE.md)** - Multi-agent coordination with Agent Mail
|
|
- **[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
|
|
- **[claude-code-skill/](claude-code-skill/)** - Claude Code skill for effective beads usage patterns
|
|
|
|
### Tools & Utilities
|
|
- **[monitor-webui/](monitor-webui/)** - Standalone web interface for real-time issue monitoring and visualization
|
|
- **[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
|
|
<!-- REMOVED (bd-4c74): branch-merge example - collision resolution no longer needed with hash IDs -->
|
|
|
|
### 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> --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.
|