Skip to content

Commit a38be61

Browse files
aspiersaspiers
committed
bd init: initialize beads issue tracking
1 parent 9beb487 commit a38be61

12 files changed

Lines changed: 363 additions & 0 deletions

‎.beads/.gitignore‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Dolt database (managed by Dolt, not git)
2+
dolt/
3+
dolt-access.lock
4+
5+
# Runtime files
6+
bd.sock
7+
bd.sock.startlock
8+
sync-state.json
9+
last-touched
10+
11+
# Local version tracking (prevents upgrade notification spam after git ops)
12+
.local_version
13+
14+
# Worktree redirect file (contains relative path to main repo's .beads/)
15+
# Must not be committed as paths would be wrong in other clones
16+
redirect
17+
18+
# Sync state (local-only, per-machine)
19+
# These files are machine-specific and should not be shared across clones
20+
.sync.lock
21+
export-state/
22+
23+
# Ephemeral store (SQLite - wisps/molecules, intentionally not versioned)
24+
ephemeral.sqlite3
25+
ephemeral.sqlite3-journal
26+
ephemeral.sqlite3-wal
27+
ephemeral.sqlite3-shm
28+
29+
# Dolt server management (auto-started by bd)
30+
dolt-server.pid
31+
dolt-server.log
32+
dolt-server.lock
33+
dolt-server.port
34+
dolt-server.activity
35+
dolt-monitor.pid
36+
37+
# Legacy files (from pre-Dolt versions)
38+
*.db
39+
*.db?*
40+
*.db-journal
41+
*.db-wal
42+
*.db-shm
43+
db.sqlite
44+
bd.db
45+
daemon.lock
46+
daemon.log
47+
daemon-*.log.gz
48+
daemon.pid
49+
# NOTE: Do NOT add negation patterns here.
50+
# They would override fork protection in .git/info/exclude.
51+
# Config files (metadata.json, config.yaml) are tracked by git by default
52+
# since no pattern above ignores them.

‎.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: "lex"
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/hooks/post-checkout‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v0.58.0 ---
3+
# This section is managed by beads. Do not remove these markers.
4+
if command -v bd >/dev/null 2>&1; then
5+
export BD_GIT_HOOK=1
6+
bd hooks run post-checkout "$@"
7+
_bd_exit=$?; if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
8+
fi
9+
# --- END BEADS INTEGRATION ---

‎.beads/hooks/post-merge‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v0.58.0 ---
3+
# This section is managed by beads. Do not remove these markers.
4+
if command -v bd >/dev/null 2>&1; then
5+
export BD_GIT_HOOK=1
6+
bd hooks run post-merge "$@"
7+
_bd_exit=$?; if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
8+
fi
9+
# --- END BEADS INTEGRATION ---

‎.beads/hooks/pre-commit‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v0.58.0 ---
3+
# This section is managed by beads. Do not remove these markers.
4+
if command -v bd >/dev/null 2>&1; then
5+
export BD_GIT_HOOK=1
6+
bd hooks run pre-commit "$@"
7+
_bd_exit=$?; if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
8+
fi
9+
# --- END BEADS INTEGRATION ---

‎.beads/hooks/pre-push‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v0.58.0 ---
3+
# This section is managed by beads. Do not remove these markers.
4+
if command -v bd >/dev/null 2>&1; then
5+
export BD_GIT_HOOK=1
6+
bd hooks run pre-push "$@"
7+
_bd_exit=$?; if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
8+
fi
9+
# --- END BEADS INTEGRATION ---

‎.beads/hooks/prepare-commit-msg‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v0.58.0 ---
3+
# This section is managed by beads. Do not remove these markers.
4+
if command -v bd >/dev/null 2>&1; then
5+
export BD_GIT_HOOK=1
6+
bd hooks run prepare-commit-msg "$@"
7+
_bd_exit=$?; if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
8+
fi
9+
# --- END BEADS INTEGRATION ---

‎.beads/interactions.jsonl‎

Whitespace-only changes.

‎.beads/metadata.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"database": "dolt",
3+
"backend": "dolt",
4+
"dolt_mode": "server",
5+
"dolt_database": "hypercerts-lexicon"
6+
}

0 commit comments

Comments
 (0)