aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrett Parson <brett@brett-parson.com>2026-08-21 13:37:19 -0500
committerBrett Parson <brett@brett-parson.com>2026-08-21 13:37:19 -0500
commit0de77a6334cee1f6e15f7e0fd35602514560be33 (patch)
treedbd4f7898b0dd72c76e327c182814612d378e7a8
downloadminiroute-0de77a6334cee1f6e15f7e0fd35602514560be33.tar.gz
miniroute-0de77a6334cee1f6e15f7e0fd35602514560be33.zip
bd init: initialize beads issue tracking
-rw-r--r--.beads/.gitignore72
-rw-r--r--.beads/README.md81
-rw-r--r--.beads/config.yaml54
-rwxr-xr-x.beads/hooks/post-checkout24
-rwxr-xr-x.beads/hooks/post-merge24
-rwxr-xr-x.beads/hooks/pre-commit24
-rwxr-xr-x.beads/hooks/pre-push24
-rwxr-xr-x.beads/hooks/prepare-commit-msg24
-rw-r--r--.beads/metadata.json7
-rw-r--r--.claude/settings.json26
-rw-r--r--.gitignore9
-rw-r--r--AGENTS.md80
-rw-r--r--CLAUDE.md69
13 files changed, 518 insertions, 0 deletions
diff --git a/.beads/.gitignore b/.beads/.gitignore
new file mode 100644
index 0000000..eb82c48
--- /dev/null
+++ b/.beads/.gitignore
@@ -0,0 +1,72 @@
+# Dolt database (managed by Dolt, not git)
+dolt/
+
+# Runtime files
+bd.sock
+bd.sock.startlock
+sync-state.json
+last-touched
+.exclusive-lock
+
+# Daemon runtime (lock, log, pid)
+daemon.*
+
+# Interactions log (runtime, not versioned)
+interactions.jsonl
+
+# Push state (runtime, per-machine)
+push-state.json
+
+# Lock files (various runtime locks)
+*.lock
+
+# Credential key (encryption key for federation peer auth — never commit)
+.beads-credential-key
+
+# Local version tracking (prevents upgrade notification spam after git ops)
+.local_version
+
+# Worktree redirect file (contains relative path to main repo's .beads/)
+# Must not be committed as paths would be wrong in other clones
+redirect
+
+# Sync state (local-only, per-machine)
+# These files are machine-specific and should not be shared across clones
+.sync.lock
+export-state/
+export-state.json
+
+# Ephemeral store (SQLite - wisps/molecules, intentionally not versioned)
+ephemeral.sqlite3
+ephemeral.sqlite3-journal
+ephemeral.sqlite3-wal
+ephemeral.sqlite3-shm
+
+# Dolt server management (auto-started by bd)
+dolt-server.pid
+dolt-server.log
+dolt-server.lock
+dolt-server.port
+dolt-server.activity
+
+# Corrupt backup directories (created by bd doctor --fix recovery)
+*.corrupt.backup/
+
+# Backup data (auto-exported JSONL, local-only)
+backup/
+
+# Per-project environment file (Dolt connection config, GH#2520)
+.env
+
+# Legacy files (from pre-Dolt versions)
+*.db
+*.db?*
+*.db-journal
+*.db-wal
+*.db-shm
+db.sqlite
+bd.db
+# NOTE: Do NOT add negation patterns here.
+# They would override fork protection in .git/info/exclude.
+# Config files (metadata.json, config.yaml) are tracked by git by default
+# since no pattern above ignores them.
diff --git a/.beads/README.md b/.beads/README.md
new file mode 100644
index 0000000..dbfe363
--- /dev/null
+++ b/.beads/README.md
@@ -0,0 +1,81 @@
+# Beads - AI-Native Issue Tracking
+
+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.
+
+## What is Beads?
+
+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.
+
+**Learn more:** [github.com/steveyegge/beads](https://github.com/steveyegge/beads)
+
+## Quick Start
+
+### Essential Commands
+
+```bash
+# Create new issues
+bd create "Add user authentication"
+
+# View all issues
+bd list
+
+# View issue details
+bd show <issue-id>
+
+# Update issue status
+bd update <issue-id> --claim
+bd update <issue-id> --status done
+
+# Sync with Dolt remote
+bd dolt push
+```
+
+### Working with Issues
+
+Issues in Beads are:
+- **Git-native**: Stored in Dolt database with version control and branching
+- **AI-friendly**: CLI-first design works perfectly with AI coding agents
+- **Branch-aware**: Issues can follow your branch workflow
+- **Always in sync**: Auto-syncs with your commits
+
+## Why Beads?
+
+✨ **AI-Native Design**
+- Built specifically for AI-assisted development workflows
+- CLI-first interface works seamlessly with AI coding agents
+- No context switching to web UIs
+
+🚀 **Developer Focused**
+- Issues live in your repo, right next to your code
+- Works offline, syncs when you push
+- Fast, lightweight, and stays out of your way
+
+🔧 **Git Integration**
+- Automatic sync with git commits
+- Branch-aware issue tracking
+- Dolt-native three-way merge resolution
+
+## Get Started with Beads
+
+Try Beads in your own projects:
+
+```bash
+# Install Beads
+curl -sSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
+
+# Initialize in your repo
+bd init
+
+# Create your first issue
+bd create "Try out Beads"
+```
+
+## Learn More
+
+- **Documentation**: [github.com/steveyegge/beads/docs](https://github.com/steveyegge/beads/tree/main/docs)
+- **Quick Start Guide**: Run `bd quickstart`
+- **Examples**: [github.com/steveyegge/beads/examples](https://github.com/steveyegge/beads/tree/main/examples)
+
+---
+
+*Beads: Issue tracking that moves at the speed of thought* ⚡
diff --git a/.beads/config.yaml b/.beads/config.yaml
new file mode 100644
index 0000000..232b151
--- /dev/null
+++ b/.beads/config.yaml
@@ -0,0 +1,54 @@
+# Beads Configuration File
+# This file configures default behavior for all bd commands in this repository
+# All settings can also be set via environment variables (BD_* prefix)
+# or overridden with command-line flags
+
+# Issue prefix for this repository (used by bd init)
+# If not set, bd init will auto-detect from directory name
+# Example: issue-prefix: "myproject" creates issues like "myproject-1", "myproject-2", etc.
+# issue-prefix: ""
+
+# Use no-db mode: JSONL-only, no Dolt database
+# When true, bd will use .beads/issues.jsonl as the source of truth
+# no-db: false
+
+# Enable JSON output by default
+# json: false
+
+# Feedback title formatting for mutating commands (create/update/close/dep/edit)
+# 0 = hide titles, N > 0 = truncate to N characters
+# output:
+# title-length: 255
+
+# Default actor for audit trails (overridden by BEADS_ACTOR or --actor)
+# actor: ""
+
+# Export events (audit trail) to .beads/events.jsonl on each flush/sync
+# When enabled, new events are appended incrementally using a high-water mark.
+# Use 'bd export --events' to trigger manually regardless of this setting.
+# events-export: false
+
+# Multi-repo configuration (experimental - bd-307)
+# Allows hydrating from multiple repositories and routing writes to the correct database
+# repos:
+# primary: "." # Primary repo (where this database lives)
+# additional: # Additional repos to hydrate from (read-only)
+# - ~/beads-planning # Personal planning repo
+# - ~/work-planning # Work planning repo
+
+# JSONL backup (periodic export for off-machine recovery)
+# Auto-enabled when a git remote exists. Override explicitly:
+# backup:
+# enabled: false # Disable auto-backup entirely
+# interval: 15m # Minimum time between auto-exports
+# git-push: false # Disable git push (export locally only)
+# git-repo: "" # Separate git repo for backups (default: project repo)
+
+# Integration settings (access with 'bd config get/set')
+# These are stored in the database, not in this file:
+# - jira.url
+# - jira.project
+# - linear.url
+# - linear.api-key
+# - github.org
+# - github.repo
diff --git a/.beads/hooks/post-checkout b/.beads/hooks/post-checkout
new file mode 100755
index 0000000..67ad327
--- /dev/null
+++ b/.beads/hooks/post-checkout
@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+# --- BEGIN BEADS INTEGRATION v1.0.0 ---
+# This section is managed by beads. Do not remove these markers.
+if command -v bd >/dev/null 2>&1; then
+ export BD_GIT_HOOK=1
+ _bd_timeout=${BEADS_HOOK_TIMEOUT:-300}
+ if command -v timeout >/dev/null 2>&1; then
+ timeout "$_bd_timeout" bd hooks run post-checkout "$@"
+ _bd_exit=$?
+ if [ $_bd_exit -eq 124 ]; then
+ echo >&2 "beads: hook 'post-checkout' timed out after ${_bd_timeout}s — continuing without beads"
+ _bd_exit=0
+ fi
+ else
+ bd hooks run post-checkout "$@"
+ _bd_exit=$?
+ fi
+ if [ $_bd_exit -eq 3 ]; then
+ echo >&2 "beads: database not initialized — skipping hook 'post-checkout'"
+ _bd_exit=0
+ fi
+ if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
+fi
+# --- END BEADS INTEGRATION v1.0.0 ---
diff --git a/.beads/hooks/post-merge b/.beads/hooks/post-merge
new file mode 100755
index 0000000..a731aec
--- /dev/null
+++ b/.beads/hooks/post-merge
@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+# --- BEGIN BEADS INTEGRATION v1.0.0 ---
+# This section is managed by beads. Do not remove these markers.
+if command -v bd >/dev/null 2>&1; then
+ export BD_GIT_HOOK=1
+ _bd_timeout=${BEADS_HOOK_TIMEOUT:-300}
+ if command -v timeout >/dev/null 2>&1; then
+ timeout "$_bd_timeout" bd hooks run post-merge "$@"
+ _bd_exit=$?
+ if [ $_bd_exit -eq 124 ]; then
+ echo >&2 "beads: hook 'post-merge' timed out after ${_bd_timeout}s — continuing without beads"
+ _bd_exit=0
+ fi
+ else
+ bd hooks run post-merge "$@"
+ _bd_exit=$?
+ fi
+ if [ $_bd_exit -eq 3 ]; then
+ echo >&2 "beads: database not initialized — skipping hook 'post-merge'"
+ _bd_exit=0
+ fi
+ if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
+fi
+# --- END BEADS INTEGRATION v1.0.0 ---
diff --git a/.beads/hooks/pre-commit b/.beads/hooks/pre-commit
new file mode 100755
index 0000000..02cf2ac
--- /dev/null
+++ b/.beads/hooks/pre-commit
@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+# --- BEGIN BEADS INTEGRATION v1.0.0 ---
+# This section is managed by beads. Do not remove these markers.
+if command -v bd >/dev/null 2>&1; then
+ export BD_GIT_HOOK=1
+ _bd_timeout=${BEADS_HOOK_TIMEOUT:-300}
+ if command -v timeout >/dev/null 2>&1; then
+ timeout "$_bd_timeout" bd hooks run pre-commit "$@"
+ _bd_exit=$?
+ if [ $_bd_exit -eq 124 ]; then
+ echo >&2 "beads: hook 'pre-commit' timed out after ${_bd_timeout}s — continuing without beads"
+ _bd_exit=0
+ fi
+ else
+ bd hooks run pre-commit "$@"
+ _bd_exit=$?
+ fi
+ if [ $_bd_exit -eq 3 ]; then
+ echo >&2 "beads: database not initialized — skipping hook 'pre-commit'"
+ _bd_exit=0
+ fi
+ if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
+fi
+# --- END BEADS INTEGRATION v1.0.0 ---
diff --git a/.beads/hooks/pre-push b/.beads/hooks/pre-push
new file mode 100755
index 0000000..7918492
--- /dev/null
+++ b/.beads/hooks/pre-push
@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+# --- BEGIN BEADS INTEGRATION v1.0.0 ---
+# This section is managed by beads. Do not remove these markers.
+if command -v bd >/dev/null 2>&1; then
+ export BD_GIT_HOOK=1
+ _bd_timeout=${BEADS_HOOK_TIMEOUT:-300}
+ if command -v timeout >/dev/null 2>&1; then
+ timeout "$_bd_timeout" bd hooks run pre-push "$@"
+ _bd_exit=$?
+ if [ $_bd_exit -eq 124 ]; then
+ echo >&2 "beads: hook 'pre-push' timed out after ${_bd_timeout}s — continuing without beads"
+ _bd_exit=0
+ fi
+ else
+ bd hooks run pre-push "$@"
+ _bd_exit=$?
+ fi
+ if [ $_bd_exit -eq 3 ]; then
+ echo >&2 "beads: database not initialized — skipping hook 'pre-push'"
+ _bd_exit=0
+ fi
+ if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
+fi
+# --- END BEADS INTEGRATION v1.0.0 ---
diff --git a/.beads/hooks/prepare-commit-msg b/.beads/hooks/prepare-commit-msg
new file mode 100755
index 0000000..c0c3ce1
--- /dev/null
+++ b/.beads/hooks/prepare-commit-msg
@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+# --- BEGIN BEADS INTEGRATION v1.0.0 ---
+# This section is managed by beads. Do not remove these markers.
+if command -v bd >/dev/null 2>&1; then
+ export BD_GIT_HOOK=1
+ _bd_timeout=${BEADS_HOOK_TIMEOUT:-300}
+ if command -v timeout >/dev/null 2>&1; then
+ timeout "$_bd_timeout" bd hooks run prepare-commit-msg "$@"
+ _bd_exit=$?
+ if [ $_bd_exit -eq 124 ]; then
+ echo >&2 "beads: hook 'prepare-commit-msg' timed out after ${_bd_timeout}s — continuing without beads"
+ _bd_exit=0
+ fi
+ else
+ bd hooks run prepare-commit-msg "$@"
+ _bd_exit=$?
+ fi
+ if [ $_bd_exit -eq 3 ]; then
+ echo >&2 "beads: database not initialized — skipping hook 'prepare-commit-msg'"
+ _bd_exit=0
+ fi
+ if [ $_bd_exit -ne 0 ]; then exit $_bd_exit; fi
+fi
+# --- END BEADS INTEGRATION v1.0.0 ---
diff --git a/.beads/metadata.json b/.beads/metadata.json
new file mode 100644
index 0000000..2684efb
--- /dev/null
+++ b/.beads/metadata.json
@@ -0,0 +1,7 @@
+{
+ "database": "dolt",
+ "backend": "dolt",
+ "dolt_mode": "embedded",
+ "dolt_database": "miniroute",
+ "project_id": "7208f849-683c-4c82-b6d7-f01501eb8079"
+} \ No newline at end of file
diff --git a/.claude/settings.json b/.claude/settings.json
new file mode 100644
index 0000000..963a538
--- /dev/null
+++ b/.claude/settings.json
@@ -0,0 +1,26 @@
+{
+ "hooks": {
+ "PreCompact": [
+ {
+ "hooks": [
+ {
+ "command": "bd prime",
+ "type": "command"
+ }
+ ],
+ "matcher": ""
+ }
+ ],
+ "SessionStart": [
+ {
+ "hooks": [
+ {
+ "command": "bd prime",
+ "type": "command"
+ }
+ ],
+ "matcher": ""
+ }
+ ]
+ }
+} \ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..edc0fd9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,9 @@
+/vendor/
+/composer.lock
+.phpunit.cache/
+.phpunit.result.cache
+
+# Beads / Dolt files (added by bd init)
+.dolt/
+*.db
+.beads-credential-key
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..b537116
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,80 @@
+# Agent Instructions
+
+This project uses **bd (beads)** for issue tracking. Run `bd init` once (inside
+this directory), then `bd prime` for full workflow context.
+
+## Quick Reference
+
+```bash
+bd init # First-time setup (once)
+bd ready # Find available work
+bd show <id> # View issue details
+bd update <id> --claim # Claim work atomically
+bd close <id> # Complete work
+bd create -f docs/roadmap.md # Batch-create beads from the roadmap spec
+```
+
+## Conventions
+
+- PHP namespaces follow PSR-4 under `BrettParson\MiniRoute\` → `src/`.
+- Interfaces end in `Interface` (e.g. `MiddlewareInterface`).
+- Attributes live in `src/Attribute/`.
+- Keep runtime dependencies at zero; `phpunit` is dev-only. See `README.md`.
+- Controllers accept `RequestInterface` and return `ResponseInterface`.
+
+## Non-Interactive Shell Commands
+
+Use `cp -f`, `mv -f`, `rm -f` (and `-rf` for recursive) to avoid hanging on
+interactive confirmation prompts.
+
+## Session Completion
+
+When ending a work session, file issues for remaining work, run tests, update
+issue status, and push (`git push`, `bd dolt push`).
+
+<!-- BEGIN BEADS INTEGRATION v:1 profile:minimal hash:ca08a54f -->
+## Beads Issue Tracker
+
+This project uses **bd (beads)** for issue tracking. Run `bd prime` to see full workflow context and commands.
+
+### Quick Reference
+
+```bash
+bd ready # Find available work
+bd show <id> # View issue details
+bd update <id> --claim # Claim work
+bd close <id> # Complete work
+```
+
+### Rules
+
+- Use `bd` for ALL task tracking — do NOT use TodoWrite, TaskCreate, or markdown TODO lists
+- Run `bd prime` for detailed command reference and session close protocol
+- Use `bd remember` for persistent knowledge — do NOT use MEMORY.md files
+
+## Session Completion
+
+**When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds.
+
+**MANDATORY WORKFLOW:**
+
+1. **File issues for remaining work** - Create issues for anything that needs follow-up
+2. **Run quality gates** (if code changed) - Tests, linters, builds
+3. **Update issue status** - Close finished work, update in-progress items
+4. **PUSH TO REMOTE** - This is MANDATORY:
+ ```bash
+ git pull --rebase
+ bd dolt push
+ git push
+ git status # MUST show "up to date with origin"
+ ```
+5. **Clean up** - Clear stashes, prune remote branches
+6. **Verify** - All changes committed AND pushed
+7. **Hand off** - Provide context for next session
+
+**CRITICAL RULES:**
+- Work is NOT complete until `git push` succeeds
+- NEVER stop before pushing - that leaves work stranded locally
+- NEVER say "ready to push when you are" - YOU must push
+- If push fails, resolve and retry until it succeeds
+<!-- END BEADS INTEGRATION -->
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000..50af487
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1,69 @@
+# Project Instructions for AI Agents
+
+This file provides instructions and context for AI coding agents working on this project.
+
+<!-- BEGIN BEADS INTEGRATION v:1 profile:minimal hash:ca08a54f -->
+## Beads Issue Tracker
+
+This project uses **bd (beads)** for issue tracking. Run `bd prime` to see full workflow context and commands.
+
+### Quick Reference
+
+```bash
+bd ready # Find available work
+bd show <id> # View issue details
+bd update <id> --claim # Claim work
+bd close <id> # Complete work
+```
+
+### Rules
+
+- Use `bd` for ALL task tracking — do NOT use TodoWrite, TaskCreate, or markdown TODO lists
+- Run `bd prime` for detailed command reference and session close protocol
+- Use `bd remember` for persistent knowledge — do NOT use MEMORY.md files
+
+## Session Completion
+
+**When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds.
+
+**MANDATORY WORKFLOW:**
+
+1. **File issues for remaining work** - Create issues for anything that needs follow-up
+2. **Run quality gates** (if code changed) - Tests, linters, builds
+3. **Update issue status** - Close finished work, update in-progress items
+4. **PUSH TO REMOTE** - This is MANDATORY:
+ ```bash
+ git pull --rebase
+ bd dolt push
+ git push
+ git status # MUST show "up to date with origin"
+ ```
+5. **Clean up** - Clear stashes, prune remote branches
+6. **Verify** - All changes committed AND pushed
+7. **Hand off** - Provide context for next session
+
+**CRITICAL RULES:**
+- Work is NOT complete until `git push` succeeds
+- NEVER stop before pushing - that leaves work stranded locally
+- NEVER say "ready to push when you are" - YOU must push
+- If push fails, resolve and retry until it succeeds
+<!-- END BEADS INTEGRATION -->
+
+
+## Build & Test
+
+_Add your build and test commands here_
+
+```bash
+# Example:
+# npm install
+# npm test
+```
+
+## Architecture Overview
+
+_Add a brief overview of your project architecture_
+
+## Conventions & Patterns
+
+_Add your project-specific conventions here_