|
| 1 | +# Beads - AI-Native Issue Tracking |
| 2 | + |
| 3 | +Welcome to Beads! This repository uses **Beads** for issue tracking - a modern, AI-native tool designed to live directly in your codebase alongside your code. |
| 4 | + |
| 5 | +## What is Beads? |
| 6 | + |
| 7 | +Beads is issue tracking that lives in your repo, making it perfect for AI coding agents and developers who want their issues close to their code. No web UI required - everything works through the CLI and integrates seamlessly with git. |
| 8 | + |
| 9 | +**Learn more:** [github.com/steveyegge/beads](https://github.com/steveyegge/beads) |
| 10 | + |
| 11 | +## Quick Start |
| 12 | + |
| 13 | +### Essential Commands |
| 14 | + |
| 15 | +```bash |
| 16 | +# Create new issues |
| 17 | +bd create "Add user authentication" |
| 18 | + |
| 19 | +# View all issues |
| 20 | +bd list |
| 21 | + |
| 22 | +# View issue details |
| 23 | +bd show <issue-id> |
| 24 | + |
| 25 | +# Update issue status |
| 26 | +bd update <issue-id> --status in_progress |
| 27 | +bd update <issue-id> --status done |
| 28 | + |
| 29 | +# Sync with git remote |
| 30 | +bd sync |
| 31 | +``` |
| 32 | + |
| 33 | +### Working with Issues |
| 34 | + |
| 35 | +Issues in Beads are: |
| 36 | +- **Git-native**: Stored in `.beads/issues.jsonl` and synced like code |
| 37 | +- **AI-friendly**: CLI-first design works perfectly with AI coding agents |
| 38 | +- **Branch-aware**: Issues can follow your branch workflow |
| 39 | +- **Always in sync**: Auto-syncs with your commits |
| 40 | + |
| 41 | +## Why Beads? |
| 42 | + |
| 43 | +✨ **AI-Native Design** |
| 44 | +- Built specifically for AI-assisted development workflows |
| 45 | +- CLI-first interface works seamlessly with AI coding agents |
| 46 | +- No context switching to web UIs |
| 47 | + |
| 48 | +🚀 **Developer Focused** |
| 49 | +- Issues live in your repo, right next to your code |
| 50 | +- Works offline, syncs when you push |
| 51 | +- Fast, lightweight, and stays out of your way |
| 52 | + |
| 53 | +🔧 **Git Integration** |
| 54 | +- Automatic sync with git commits |
| 55 | +- Branch-aware issue tracking |
| 56 | +- Intelligent JSONL merge resolution |
| 57 | + |
| 58 | +## Get Started with Beads |
| 59 | + |
| 60 | +Try Beads in your own projects: |
| 61 | + |
| 62 | +```bash |
| 63 | +# Install Beads |
| 64 | +curl -sSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash |
| 65 | + |
| 66 | +# Initialize in your repo |
| 67 | +bd init |
| 68 | + |
| 69 | +# Create your first issue |
| 70 | +bd create "Try out Beads" |
| 71 | +``` |
| 72 | + |
| 73 | +## Learn More |
| 74 | + |
| 75 | +- **Documentation**: [github.com/steveyegge/beads/docs](https://github.com/steveyegge/beads/tree/main/docs) |
| 76 | +- **Quick Start Guide**: Run `bd quickstart` |
| 77 | +- **Examples**: [github.com/steveyegge/beads/examples](https://github.com/steveyegge/beads/tree/main/examples) |
| 78 | + |
| 79 | +--- |
| 80 | + |
| 81 | +*Beads: Issue tracking that moves at the speed of thought* ⚡ |
0 commit comments