| 1 | # Beads - AI-Native Issue Tracking
|
|---|
| 2 |
|
|---|
| 3 | > **The beads database in this repository is retired. Do not write to it.**
|
|---|
| 4 | >
|
|---|
| 5 | > Klonkt's issues live in `~/Sources/shaer-frontend/.beads` (Dolt database
|
|---|
| 6 | > `shaer`). All 32 of them were migrated there on 2026-08-23 keeping their
|
|---|
| 7 | > original `prutfolio-src-*` ids, so `bd show prutfolio-src-7cz` works from that
|
|---|
| 8 | > repository and means the same issue it always did.
|
|---|
| 9 | >
|
|---|
| 10 | > Create, update and close Klonkt issues from `~/Sources/shaer-frontend`. The
|
|---|
| 11 | > `bd` commands below apply there, not here.
|
|---|
| 12 | >
|
|---|
| 13 | > Why: this repository has no `core.hooksPath`, so the beads hooks in
|
|---|
| 14 | > `.beads/hooks/` never ran. The Dolt database is gitignored and the one tracked
|
|---|
| 15 | > artefact, `.beads/issues.jsonl`, is only refreshed by those hooks — it had
|
|---|
| 16 | > drifted four days and two issues behind before anyone noticed. shaer-frontend
|
|---|
| 17 | > has the hooks wired, so its export stays current.
|
|---|
| 18 | >
|
|---|
| 19 | > The local database is left in place and still readable for history. Nothing
|
|---|
| 20 | > enforces this: it is a convention, and a `bd create` run here will succeed and
|
|---|
| 21 | > be lost.
|
|---|
| 22 |
|
|---|
| 23 | 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.
|
|---|
| 24 |
|
|---|
| 25 | ## What is Beads?
|
|---|
| 26 |
|
|---|
| 27 | 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.
|
|---|
| 28 |
|
|---|
| 29 | **Learn more:** [github.com/steveyegge/beads](https://github.com/steveyegge/beads)
|
|---|
| 30 |
|
|---|
| 31 | ## Quick Start
|
|---|
| 32 |
|
|---|
| 33 | ### Essential Commands
|
|---|
| 34 |
|
|---|
| 35 | ```bash
|
|---|
| 36 | # Create new issues
|
|---|
| 37 | bd create "Add user authentication"
|
|---|
| 38 |
|
|---|
| 39 | # View all issues
|
|---|
| 40 | bd list
|
|---|
| 41 |
|
|---|
| 42 | # View issue details
|
|---|
| 43 | bd show <issue-id>
|
|---|
| 44 |
|
|---|
| 45 | # Update issue status
|
|---|
| 46 | bd update <issue-id> --claim
|
|---|
| 47 | bd update <issue-id> --status done
|
|---|
| 48 |
|
|---|
| 49 | # Sync with Dolt remote
|
|---|
| 50 | bd dolt push
|
|---|
| 51 | ```
|
|---|
| 52 |
|
|---|
| 53 | ### Working with Issues
|
|---|
| 54 |
|
|---|
| 55 | Issues in Beads are:
|
|---|
| 56 | - **Git-native**: Stored in Dolt database with version control and branching
|
|---|
| 57 | - **AI-friendly**: CLI-first design works perfectly with AI coding agents
|
|---|
| 58 | - **Branch-aware**: Issues can follow your branch workflow
|
|---|
| 59 | - **Always in sync**: Auto-syncs with your commits
|
|---|
| 60 |
|
|---|
| 61 | ## Why Beads?
|
|---|
| 62 |
|
|---|
| 63 | ✨ **AI-Native Design**
|
|---|
| 64 | - Built specifically for AI-assisted development workflows
|
|---|
| 65 | - CLI-first interface works seamlessly with AI coding agents
|
|---|
| 66 | - No context switching to web UIs
|
|---|
| 67 |
|
|---|
| 68 | 🚀 **Developer Focused**
|
|---|
| 69 | - Issues live in your repo, right next to your code
|
|---|
| 70 | - Works offline, syncs when you push
|
|---|
| 71 | - Fast, lightweight, and stays out of your way
|
|---|
| 72 |
|
|---|
| 73 | 🔧 **Git Integration**
|
|---|
| 74 | - Automatic sync with git commits
|
|---|
| 75 | - Branch-aware issue tracking
|
|---|
| 76 | - Dolt-native three-way merge resolution
|
|---|
| 77 |
|
|---|
| 78 | ## Get Started with Beads
|
|---|
| 79 |
|
|---|
| 80 | Try Beads in your own projects:
|
|---|
| 81 |
|
|---|
| 82 | ```bash
|
|---|
| 83 | # Install Beads
|
|---|
| 84 | curl -sSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
|---|
| 85 |
|
|---|
| 86 | # Initialize in your repo
|
|---|
| 87 | bd init
|
|---|
| 88 |
|
|---|
| 89 | # Create your first issue
|
|---|
| 90 | bd create "Try out Beads"
|
|---|
| 91 | ```
|
|---|
| 92 |
|
|---|
| 93 | ## Learn More
|
|---|
| 94 |
|
|---|
| 95 | - **Documentation**: [github.com/steveyegge/beads/docs](https://github.com/steveyegge/beads/tree/main/docs)
|
|---|
| 96 | - **Quick Start Guide**: Run `bd quickstart`
|
|---|
| 97 | - **Examples**: [github.com/steveyegge/beads/examples](https://github.com/steveyegge/beads/tree/main/examples)
|
|---|
| 98 |
|
|---|
| 99 | ---
|
|---|
| 100 |
|
|---|
| 101 | *Beads: Issue tracking that moves at the speed of thought* ⚡
|
|---|