Files
beads/examples/bash-agent/README.md
Steve Yegge 19cd7d1887 Prepare for public launch: comprehensive examples, docs, and tooling
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>
2025-10-12 11:25:29 -07:00

125 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Bash Agent Example
A bash script demonstrating how an AI agent can use bd to manage tasks autonomously.
## Features
- Pure bash implementation (no Python/Node required)
- Colorized terminal output
- Automatic work discovery
- Random issue creation to simulate real agent behavior
- Dependency linking with `discovered-from`
- Statistics display
## Prerequisites
- bash 4.0+
- bd installed: `go install github.com/steveyegge/beads/cmd/bd@latest`
- jq for JSON parsing: `brew install jq` (macOS) or `apt install jq` (Linux)
- A beads database initialized: `bd init`
## Usage
```bash
# Make executable
chmod +x agent.sh
# Run with default 10 iterations
./agent.sh
# Run with custom iteration limit
./agent.sh 20
```
## What It Does
The agent runs in a loop:
1. Looks for ready work (no blockers)
2. Claims the task (sets status to `in_progress`)
3. "Works" on it (simulates 1 second of work)
4. 50% chance to discover a follow-up issue
5. If discovered, creates and links the new issue
6. Completes the original task
7. Shows statistics and repeats
## Example Output
```
🚀 Beads Agent starting...
Max iterations: 10
═══════════════════════════════════════════════════
Beads Statistics
═══════════════════════════════════════════════════
Open: 5 In Progress: 0 Closed: 2
═══════════════════════════════════════════════════
Iteration 1/10
═══════════════════════════════════════════════════
Looking for ready work...
Claiming task: bd-3
✓ Task claimed
Working on: Fix authentication bug (bd-3)
Priority: 1
⚠ Discovered issue while working!
✓ Created issue: bd-8
✓ Linked bd-8 ← discovered-from ← bd-3
Completing task: bd-3
✓ Task completed: bd-3
```
## Use Cases
**Continuous Integration**
```bash
# Run agent in CI to process testing tasks
./agent.sh 5
```
**Cron Jobs**
```bash
# Run agent every hour
0 * * * * cd /path/to/project && /path/to/agent.sh 3
```
**One-off Task Processing**
```bash
# Process exactly one task and exit
./agent.sh 1
```
## Customization
Edit the script to customize behavior:
```bash
# Change discovery probability (line ~80)
if [[ $((RANDOM % 2)) -eq 0 ]]; then # 50% chance
# Change to:
if [[ $((RANDOM % 10)) -lt 3 ]]; then # 30% chance
# Add assignee filtering
bd ready --json --assignee "bot" --limit 1
# Add priority filtering
bd ready --json --priority 1 --limit 1
# Add custom labels
bd create "New task" -l "automated,agent-discovered"
```
## Integration with Real Agents
This script is a starting point. To integrate with a real LLM:
1. Replace `do_work()` with calls to your LLM API
2. Parse the LLM's response for tasks to create
3. Use issue IDs to maintain context
4. Track conversation state in issue metadata
## See Also
- [../python-agent/](../python-agent/) - Python version with more flexibility
- [../git-hooks/](../git-hooks/) - Automatic export/import on git operations