Skip to content

Commit 04b8307

Browse files
cscheidcscheid
committed
update
1 parent 33f16b9 commit 04b8307

7 files changed

Lines changed: 827 additions & 89 deletions

File tree

‎.beads/README.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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* ⚡

‎.beads/config.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Beads Configuration File
2+
# This file configures default behavior for all bd commands in this repository
3+
# All settings can also be set via environment variables (BD_* prefix)
4+
# or overridden with command-line flags
5+
6+
# Issue prefix for this repository (used by bd init)
7+
# If not set, bd init will auto-detect from directory name
8+
# Example: issue-prefix: "myproject" creates issues like "myproject-1", "myproject-2", etc.
9+
# issue-prefix: ""
10+
11+
# Use no-db mode: load from JSONL, no SQLite, write back after each command
12+
# When true, bd will use .beads/issues.jsonl as the source of truth
13+
# instead of SQLite database
14+
# no-db: false
15+
16+
# Disable daemon for RPC communication (forces direct database access)
17+
# no-daemon: false
18+
19+
# Disable auto-flush of database to JSONL after mutations
20+
# no-auto-flush: false
21+
22+
# Disable auto-import from JSONL when it's newer than database
23+
# no-auto-import: false
24+
25+
# Enable JSON output by default
26+
# json: false
27+
28+
# Default actor for audit trails (overridden by BD_ACTOR or --actor)
29+
# actor: ""
30+
31+
# Path to database (overridden by BEADS_DB or --db)
32+
# db: ""
33+
34+
# Auto-start daemon if not running (can also use BEADS_AUTO_START_DAEMON)
35+
# auto-start-daemon: true
36+
37+
# Debounce interval for auto-flush (can also use BEADS_FLUSH_DEBOUNCE)
38+
# flush-debounce: "5s"
39+
40+
# Git branch for beads commits (bd sync will commit to this branch)
41+
# IMPORTANT: Set this for team projects so all clones use the same sync branch.
42+
# This setting persists across clones (unlike database config which is gitignored).
43+
# Can also use BEADS_SYNC_BRANCH env var for local override.
44+
# If not set, bd sync will require you to run 'bd config set sync.branch <branch>'.
45+
# sync-branch: "beads-sync"
46+
47+
# Multi-repo configuration (experimental - bd-307)
48+
# Allows hydrating from multiple repositories and routing writes to the correct JSONL
49+
# repos:
50+
# primary: "." # Primary repo (where this database lives)
51+
# additional: # Additional repos to hydrate from (read-only)
52+
# - ~/beads-planning # Personal planning repo
53+
# - ~/work-planning # Work planning repo
54+
55+
# Integration settings (access with 'bd config get/set')
56+
# These are stored in the database, not in this file:
57+
# - jira.url
58+
# - jira.project
59+
# - linear.url
60+
# - linear.api-key
61+
# - github.org
62+
# - github.repo

‎.beads/deletions.jsonl‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{"id":"qmd-2","ts":"2025-12-11T14:59:50.017034Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
2+
{"id":"qmd-10","ts":"2025-12-11T14:59:50.024088Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
3+
{"id":"bd-5","ts":"2025-12-11T14:59:50.032591Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
4+
{"id":"bd-13","ts":"2025-12-11T14:59:50.037594Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
5+
{"id":"bd-12","ts":"2025-12-11T14:59:50.045682Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
6+
{"id":"qmd-5","ts":"2025-12-11T14:59:50.050562Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
7+
{"id":"qmd-42","ts":"2025-12-11T14:59:50.055791Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
8+
{"id":"qmd-36","ts":"2025-12-11T14:59:50.060556Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
9+
{"id":"qmd-35","ts":"2025-12-11T14:59:50.065621Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
10+
{"id":"qmd-34","ts":"2025-12-11T14:59:50.070607Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
11+
{"id":"qmd-33","ts":"2025-12-11T14:59:50.075686Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
12+
{"id":"qmd-31","ts":"2025-12-11T14:59:50.080732Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
13+
{"id":"qmd-30","ts":"2025-12-11T14:59:50.085657Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
14+
{"id":"qmd-3","ts":"2025-12-11T14:59:50.090593Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
15+
{"id":"qmd-29","ts":"2025-12-11T14:59:50.095387Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
16+
{"id":"qmd-27","ts":"2025-12-11T14:59:50.100537Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
17+
{"id":"qmd-26","ts":"2025-12-11T14:59:50.105598Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
18+
{"id":"qmd-25","ts":"2025-12-11T14:59:50.110485Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
19+
{"id":"qmd-24","ts":"2025-12-11T14:59:50.115664Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
20+
{"id":"qmd-23","ts":"2025-12-11T14:59:50.120666Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
21+
{"id":"qmd-22","ts":"2025-12-11T14:59:50.125709Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
22+
{"id":"qmd-20","ts":"2025-12-11T14:59:50.130378Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
23+
{"id":"qmd-19","ts":"2025-12-11T14:59:50.135455Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
24+
{"id":"qmd-18","ts":"2025-12-11T14:59:50.140561Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
25+
{"id":"qmd-17","ts":"2025-12-11T14:59:50.145457Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
26+
{"id":"qmd-16","ts":"2025-12-11T14:59:50.150661Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
27+
{"id":"qmd-12","ts":"2025-12-11T14:59:50.155691Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
28+
{"id":"bd-8","ts":"2025-12-11T14:59:50.160587Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
29+
{"id":"bd-7","ts":"2025-12-11T14:59:50.165531Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
30+
{"id":"bd-14","ts":"2025-12-11T14:59:50.170559Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
31+
{"id":"bd-1","ts":"2025-12-11T14:59:50.175493Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
32+
{"id":"qmd-9","ts":"2025-12-11T14:59:50.180422Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
33+
{"id":"qmd-8","ts":"2025-12-11T14:59:50.185762Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
34+
{"id":"qmd-7","ts":"2025-12-11T14:59:50.190602Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
35+
{"id":"qmd-6","ts":"2025-12-11T14:59:50.195572Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
36+
{"id":"qmd-43","ts":"2025-12-11T14:59:50.200498Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
37+
{"id":"qmd-41","ts":"2025-12-11T14:59:50.205632Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
38+
{"id":"qmd-40","ts":"2025-12-11T14:59:50.210427Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
39+
{"id":"qmd-4","ts":"2025-12-11T14:59:50.215538Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
40+
{"id":"qmd-39","ts":"2025-12-11T14:59:50.221808Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
41+
{"id":"qmd-38","ts":"2025-12-11T14:59:50.226927Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
42+
{"id":"qmd-37","ts":"2025-12-11T14:59:50.231534Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
43+
{"id":"qmd-32","ts":"2025-12-11T14:59:50.236455Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
44+
{"id":"qmd-21","ts":"2025-12-11T14:59:50.241454Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
45+
{"id":"qmd-15","ts":"2025-12-11T14:59:50.246481Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
46+
{"id":"qmd-14","ts":"2025-12-11T14:59:50.251445Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
47+
{"id":"qmd-1","ts":"2025-12-11T14:59:50.256603Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
48+
{"id":"bd-4","ts":"2025-12-11T14:59:50.261541Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
49+
{"id":"bd-3","ts":"2025-12-11T14:59:50.267002Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
50+
{"id":"bd-21","ts":"2025-12-11T14:59:50.272304Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
51+
{"id":"bd-20","ts":"2025-12-11T14:59:50.277355Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
52+
{"id":"bd-2","ts":"2025-12-11T14:59:50.282509Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
53+
{"id":"bd-19","ts":"2025-12-11T14:59:50.287576Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
54+
{"id":"bd-18","ts":"2025-12-11T14:59:50.292447Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
55+
{"id":"bd-17","ts":"2025-12-11T14:59:50.297509Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
56+
{"id":"bd-16","ts":"2025-12-11T14:59:50.30255Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
57+
{"id":"bd-15","ts":"2025-12-11T14:59:50.30751Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
58+
{"id":"bd-11","ts":"2025-12-11T14:59:50.312402Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
59+
{"id":"bd-10","ts":"2025-12-11T14:59:50.317472Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
60+
{"id":"qmd-28","ts":"2025-12-11T14:59:50.322647Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
61+
{"id":"bd-6","ts":"2025-12-11T14:59:50.32762Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
62+
{"id":"qmd-13","ts":"2025-12-11T14:59:50.332436Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
63+
{"id":"qmd-11","ts":"2025-12-11T14:59:50.337462Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}
64+
{"id":"bd-9","ts":"2025-12-11T14:59:50.342752Z","by":"git-history-backfill","reason":"recovered from git history (pruned from manifest)"}

0 commit comments

Comments
 (0)