19cd7d1887
This commit adds everything needed for a successful public launch: **New Documentation** - SECURITY.md: Security policy and best practices - CLAUDE.md: Complete agent instructions for contributing to beads - Enhanced README with pain points, FAQ, troubleshooting sections - Added Taskwarrior to comparison table with detailed explanation **Installation** - install.sh: One-liner installation script with platform detection - Auto-detects OS/arch, tries go install, falls back to building from source - Updated README with prominent installation instructions **Examples** (2,268+ lines of working code) - examples/python-agent/: Full Python implementation of agent workflow - examples/bash-agent/: Shell script agent with colorized output - examples/git-hooks/: Pre-commit, post-merge, post-checkout hooks with installer - examples/claude-desktop-mcp/: Documentation for future MCP server integration - examples/README.md: Overview of all examples **Dogfooding** - Initialized bd in beads project itself (.beads/beads.db) - Created issues for roadmap (MCP server, migrations, demos, 1.0 milestone) - Exported to .beads/issues.jsonl for git versioning **Visual Assets** - Added screenshot showing agent using beads to README intro - Placed in .github/images/ following GitHub conventions This addresses all launch readiness items: ✅ Security policy ✅ Working agent examples (Python, Bash) ✅ Git hooks for automation ✅ FAQ addressing skeptics ✅ Troubleshooting common issues ✅ Easy installation ✅ Dogfooding our own tool ✅ Pain points that create urgency Ready to ship! 🚀 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1.1 KiB
1.1 KiB
Beads Examples
This directory contains examples of how to integrate bd with AI agents and workflows.
Examples
- python-agent/ - Simple Python agent that discovers ready work and completes tasks
- bash-agent/ - Bash script showing the full agent workflow
- git-hooks/ - Pre-configured git hooks for automatic export/import
- claude-desktop-mcp/ - MCP server for Claude Desktop integration
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
Creating Your Own Agent
The basic agent workflow:
- Find ready work:
bd ready --json --limit 1 - Claim the task:
bd update <id> --status in_progress --json - Do the work: Execute the task
- Discover new issues:
bd create "Found bug" --json - Link discoveries:
bd dep add <new-id> <parent-id> --type discovered-from - Complete the task:
bd close <id> --reason "Done" --json
All commands support --json for easy parsing.