Skip to content

Commit 424ade9

Browse files
GeiserXGeiserX
authored
chore(beads): give agents a tracker here that never publishes bead text (#44)
Agents here had no beads tracker. Add the beads setup: .beads config, README, .gitignore, metadata and hooks, AGENTS.md, the beads block in CLAUDE.md and the SessionStart bd prime hook. Bead text stays out of git, and the tracker syncs only to the private giteaer/Wayback-Diff-beads repo on Gitea.
1 parent f0d6744 commit 424ade9

13 files changed

Lines changed: 588 additions & 0 deletions

File tree

‎.beads/.gitignore‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Dolt database (managed by Dolt, not git)
2+
dolt/
3+
embeddeddolt/
4+
proxieddb/
5+
6+
# Bead text lives in the Dolt tracker only, never in git
7+
issues.jsonl
8+
interactions.jsonl
9+
events.jsonl
10+
11+
# Runtime files
12+
bd.sock
13+
bd.sock.startlock
14+
sync-state.json
15+
last-touched
16+
.exclusive-lock
17+
18+
# Daemon runtime (lock, log, pid)
19+
daemon.*
20+
21+
# Push state (runtime, per-machine)
22+
push-state.json
23+
24+
# Lock files (various runtime locks)
25+
*.lock
26+
27+
# Credential key (encryption key for federation peer auth — never commit)
28+
.beads-credential-key
29+
30+
# Local version tracking (prevents upgrade notification spam after git ops)
31+
.local_version
32+
33+
proxied_server_client_info.json
34+
35+
# Worktree redirect file (contains relative path to main repo's .beads/)
36+
# Must not be committed as paths would be wrong in other clones
37+
redirect
38+
39+
# Sync state (local-only, per-machine)
40+
# These files are machine-specific and should not be shared across clones
41+
.sync.lock
42+
export-state/
43+
export-state.json
44+
last_pull
45+
46+
# Ephemeral store (SQLite - wisps/molecules, intentionally not versioned)
47+
ephemeral.sqlite3
48+
ephemeral.sqlite3-journal
49+
ephemeral.sqlite3-wal
50+
ephemeral.sqlite3-shm
51+
52+
# Dolt server management (auto-started by bd)
53+
dolt-server.pid
54+
dolt-server.log
55+
dolt-server.lock
56+
dolt-server.port
57+
dolt-server.activity
58+
59+
# Debug-mode pprof artifacts (written when dolt.debug: true in config.yaml)
60+
dolt-pprof/
61+
62+
# Corrupt backup directories (created by bd doctor --fix recovery)
63+
*.corrupt.backup/
64+
65+
# Backup data (auto-exported JSONL, local-only)
66+
backup/
67+
68+
# Per-project environment file (Dolt connection config, GH#2520)
69+
.env
70+
71+
# Legacy files (from pre-Dolt versions)
72+
*.db
73+
*.db?*
74+
*.db-journal
75+
*.db-wal
76+
*.db-shm
77+
db.sqlite
78+
bd.db
79+
# NOTE: Do NOT add negation patterns here.
80+
# They would override fork protection in .git/info/exclude.
81+
# Config files (metadata.json, config.yaml) are tracked by git by default
82+
# 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> --claim
27+
bd update <issue-id> --status done
28+
29+
# Sync with Dolt remote
30+
bd dolt push
31+
```
32+
33+
### Working with Issues
34+
35+
Issues in Beads are:
36+
- **Git-native**: Stored in Dolt database with version control and branching
37+
- **AI-friendly**: CLI-first design works perfectly with AI coding agents
38+
- **Branch-aware**: Issues can follow your branch workflow
39+
- **Sync-ready**: Uses Dolt remotes for backup and team sharing
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+
- Dolt-native sync via bd dolt push / bd dolt pull
55+
- Branch-aware issue tracking
56+
- Dolt-native three-way 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: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
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: JSONL-only, no Dolt database
12+
# When true, .beads/issues.jsonl is the only local store
13+
# no-db: false
14+
15+
# Enable JSON output by default
16+
# json: false
17+
18+
# Feedback title formatting for mutating commands (create/update/close/dep/edit)
19+
# 0 = hide titles, N > 0 = truncate to N characters
20+
# output:
21+
# title-length: 255
22+
23+
# Default actor for audit trails (overridden by BEADS_ACTOR or --actor)
24+
# actor: ""
25+
26+
# Export events (audit trail) to .beads/events.jsonl on each flush/sync
27+
# When enabled, new events are appended incrementally using a high-water mark.
28+
# Use 'bd export --events' to trigger manually regardless of this setting.
29+
# events-export: false
30+
31+
# Multi-repo configuration (experimental - bd-307)
32+
# Allows hydrating from multiple repositories and routing writes to the correct database
33+
# repos:
34+
# primary: "." # Primary repo (where this database lives)
35+
# additional: # Additional repos to hydrate from (read-only)
36+
# - ~/beads-planning # Personal planning repo
37+
# - ~/work-planning # Work planning repo
38+
39+
# Dolt-native backup (periodic backup for off-machine recovery)
40+
# This is full database backup only. Cross-machine sync uses Dolt remotes.
41+
# backup:
42+
# enabled: false # Disable auto-backup entirely
43+
# interval: 15m # Minimum time between auto-backups
44+
# git-push: false # Disable git push (backup locally only)
45+
# git-repo: "" # Separate git repo for backups (default: project repo)
46+
47+
# Optional JSONL auto-export for viewers, interchange, and issue-level migration.
48+
# Disabled by default; enable only when an integration needs fresh .beads/issues.jsonl.
49+
# Use relative paths under .beads/ for JSONL import/export filenames.
50+
# export:
51+
# auto: false
52+
# path: issues.jsonl
53+
# interval: 60s
54+
# git-add: false
55+
# import:
56+
# path: issues.jsonl
57+
58+
# Integration settings (access with 'bd config get/set')
59+
# Non-secret keys (stored in the database):
60+
# - jira.url, jira.project
61+
# - linear.team_id
62+
# - github.org, github.repo
63+
#
64+
# Secret keys (stored in this file but prefer env vars to avoid git exposure):
65+
# - linear.api_key → use LINEAR_API_KEY env var instead
66+
# - github.token → use GITHUB_TOKEN env var instead
67+
68+
# Public repo: the tracker syncs only to this private Gitea repo, never to GitHub.
69+
sync.remote: "git+ssh://git@gitea.geiser.cloud:2222/giteaer/Wayback-Diff-beads.git"
70+
# Every bd write is a Dolt commit, so a push always carries it.
71+
dolt.auto-commit: "on"

‎.beads/hooks/post-checkout‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v1.1.2 ---
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_timeout=${BEADS_HOOK_TIMEOUT:-300}
7+
_bd_used_perl=0
8+
if command -v timeout >/dev/null 2>&1; then
9+
timeout "$_bd_timeout" bd hooks run post-checkout "$@"
10+
_bd_exit=$?
11+
elif command -v gtimeout >/dev/null 2>&1; then
12+
gtimeout "$_bd_timeout" bd hooks run post-checkout "$@"
13+
_bd_exit=$?
14+
elif command -v perl >/dev/null 2>&1; then
15+
_bd_used_perl=1
16+
perl -e 'alarm shift; exec @ARGV' "$_bd_timeout" bd hooks run post-checkout "$@"
17+
_bd_exit=$?
18+
else
19+
echo >&2 "beads: hook 'post-checkout' running without timeout; install coreutils or perl to enable BEADS_HOOK_TIMEOUT"
20+
bd hooks run post-checkout "$@"
21+
_bd_exit=$?
22+
fi
23+
if [ $_bd_exit -eq 124 ] || { [ $_bd_used_perl -eq 1 ] && [ $_bd_exit -eq 142 ]; }; then
24+
echo >&2 "beads: hook 'post-checkout' timed out after ${_bd_timeout}s — continuing without beads"
25+
_bd_exit=0
26+
fi
27+
if [ $_bd_exit -eq 3 ]; then
28+
echo >&2 "beads: database not initialized — skipping hook 'post-checkout'"
29+
_bd_exit=0
30+
fi
31+
if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
32+
fi
33+
# --- END BEADS INTEGRATION v1.1.2 ---

‎.beads/hooks/post-merge‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v1.1.2 ---
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_timeout=${BEADS_HOOK_TIMEOUT:-300}
7+
_bd_used_perl=0
8+
if command -v timeout >/dev/null 2>&1; then
9+
timeout "$_bd_timeout" bd hooks run post-merge "$@"
10+
_bd_exit=$?
11+
elif command -v gtimeout >/dev/null 2>&1; then
12+
gtimeout "$_bd_timeout" bd hooks run post-merge "$@"
13+
_bd_exit=$?
14+
elif command -v perl >/dev/null 2>&1; then
15+
_bd_used_perl=1
16+
perl -e 'alarm shift; exec @ARGV' "$_bd_timeout" bd hooks run post-merge "$@"
17+
_bd_exit=$?
18+
else
19+
echo >&2 "beads: hook 'post-merge' running without timeout; install coreutils or perl to enable BEADS_HOOK_TIMEOUT"
20+
bd hooks run post-merge "$@"
21+
_bd_exit=$?
22+
fi
23+
if [ $_bd_exit -eq 124 ] || { [ $_bd_used_perl -eq 1 ] && [ $_bd_exit -eq 142 ]; }; then
24+
echo >&2 "beads: hook 'post-merge' timed out after ${_bd_timeout}s — continuing without beads"
25+
_bd_exit=0
26+
fi
27+
if [ $_bd_exit -eq 3 ]; then
28+
echo >&2 "beads: database not initialized — skipping hook 'post-merge'"
29+
_bd_exit=0
30+
fi
31+
if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
32+
fi
33+
# --- END BEADS INTEGRATION v1.1.2 ---

‎.beads/hooks/pre-commit‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v1.1.2 ---
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_timeout=${BEADS_HOOK_TIMEOUT:-300}
7+
_bd_used_perl=0
8+
if command -v timeout >/dev/null 2>&1; then
9+
timeout "$_bd_timeout" bd hooks run pre-commit "$@"
10+
_bd_exit=$?
11+
elif command -v gtimeout >/dev/null 2>&1; then
12+
gtimeout "$_bd_timeout" bd hooks run pre-commit "$@"
13+
_bd_exit=$?
14+
elif command -v perl >/dev/null 2>&1; then
15+
_bd_used_perl=1
16+
perl -e 'alarm shift; exec @ARGV' "$_bd_timeout" bd hooks run pre-commit "$@"
17+
_bd_exit=$?
18+
else
19+
echo >&2 "beads: hook 'pre-commit' running without timeout; install coreutils or perl to enable BEADS_HOOK_TIMEOUT"
20+
bd hooks run pre-commit "$@"
21+
_bd_exit=$?
22+
fi
23+
if [ $_bd_exit -eq 124 ] || { [ $_bd_used_perl -eq 1 ] && [ $_bd_exit -eq 142 ]; }; then
24+
echo >&2 "beads: hook 'pre-commit' timed out after ${_bd_timeout}s — continuing without beads"
25+
_bd_exit=0
26+
fi
27+
if [ $_bd_exit -eq 3 ]; then
28+
echo >&2 "beads: database not initialized — skipping hook 'pre-commit'"
29+
_bd_exit=0
30+
fi
31+
if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
32+
fi
33+
# --- END BEADS INTEGRATION v1.1.2 ---

‎.beads/hooks/pre-push‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#!/usr/bin/env sh
2+
# --- BEGIN BEADS INTEGRATION v1.1.2 ---
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_timeout=${BEADS_HOOK_TIMEOUT:-300}
7+
_bd_used_perl=0
8+
if command -v timeout >/dev/null 2>&1; then
9+
timeout "$_bd_timeout" bd hooks run pre-push "$@"
10+
_bd_exit=$?
11+
elif command -v gtimeout >/dev/null 2>&1; then
12+
gtimeout "$_bd_timeout" bd hooks run pre-push "$@"
13+
_bd_exit=$?
14+
elif command -v perl >/dev/null 2>&1; then
15+
_bd_used_perl=1
16+
perl -e 'alarm shift; exec @ARGV' "$_bd_timeout" bd hooks run pre-push "$@"
17+
_bd_exit=$?
18+
else
19+
echo >&2 "beads: hook 'pre-push' running without timeout; install coreutils or perl to enable BEADS_HOOK_TIMEOUT"
20+
bd hooks run pre-push "$@"
21+
_bd_exit=$?
22+
fi
23+
if [ $_bd_exit -eq 124 ] || { [ $_bd_used_perl -eq 1 ] && [ $_bd_exit -eq 142 ]; }; then
24+
echo >&2 "beads: hook 'pre-push' timed out after ${_bd_timeout}s — continuing without beads"
25+
_bd_exit=0
26+
fi
27+
if [ $_bd_exit -eq 3 ]; then
28+
echo >&2 "beads: database not initialized — skipping hook 'pre-push'"
29+
_bd_exit=0
30+
fi
31+
if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
32+
fi
33+
# --- END BEADS INTEGRATION v1.1.2 ---

0 commit comments

Comments
 (0)