- Go 95.2%
- Python 1.6%
- Starlark 1.5%
- Shell 1.3%
- Rust 0.2%
* test(feat): red — Phase 1: additive schema + migration slot claim - gastownhall/beads#6134 (refs be-hs42e.2)
Failing tests for the versioned-beads Phase 1 schema (issue_versions,
store_epoch, issues.current_revision), written before the migration file
exists so MigrationSQL("0067_add_versioned_beads_schema.up.sql") and
LatestVersion()==67 both fail RED. Confirmed via
`go test ./internal/storage/schema/...` (pipefail set — the molecule's own
`$TEST_CMD | tee` template misreports success without it, since `tee`'s
exit code masks a failing pipeline stage).
* feat: green — Phase 1: additive schema + migration slot claim - gastownhall/beads#6134 (refs be-hs42e.2)
Adds migration 0067: issue_versions (per-issue version log), store_epoch
(store-global epoch singleton, empty until a later phase seeds it), and
issues.current_revision (BIGINT NOT NULL DEFAULT 1). Purely additive, no
DML/backfill, no PREPARE/EXECUTE wrapper (ADD/DROP COLUMN vanishes under
the CLI-bundle path on a pre-2.3 Dolt CLI — see cli_prepared_ddl.go).
Also corrects two wrong assumptions baked into the RED-step test:
- down.sql files are not part of the //go:embed'd FS (only
migrations/*.up.sql is), so MigrationSQL() can never read one for any
migration; switched to os.ReadFile, matching
TestMigration0035HandlesLegacyWispDependenciesShape's existing precedent.
- a plain TEXT column reports information_schema.columns.column_type as
"text" in this Dolt version, not "longtext" as assumed.
* test(feat): red — Review: Phase 1: additive schema + migration slot claim - gastownhall/beads#6134 (refs be-xrl84)
* feat: green — Review: Phase 1: additive schema + migration slot claim - gastownhall/beads#6134 (refs be-xrl84)
* docs(release-gates): PASS 7/7 — be-dy66n
Phase 1: additive schema + migration slot claim - gastownhall/beads#6134
(deploy bead be-4ka6t). 4 pre-existing, non-diff-owned failure/finding
classes encountered and attributed to their tracker beads (be-9ogs6,
be-irise, be-w4qbu, be-a0dxu) with clause-3 proof; zero diff-owned
failures. PR: gastownhall/beads#6304.
* fix(schema): 0067 mirrors current_revision onto wisps and guards its own raw-SQL replay (refs be-yi9vu, be-hs42e.2)
Both maintainer rulings on gastownhall/beads#6304.
1. current_revision on both planes. wisps gains
`current_revision BIGINT NOT NULL DEFAULT 1`, identical to issues.
The semantic asymmetry is kept and written down instead of hidden:
nothing in Phase 1, 2 or 3 reads or writes the wisps column —
versioning is an issues-plane contract. What it satisfies is a SHAPE
obligation. The two planes share column-list-shaped code paths, and
TestSchemaParityIssuesVsWisps enforces strict column-name parity with
no exemption list; wisps.row_lock (0054 + ignored/0013) is the
precedent for a column carried on both planes and meaningful on one.
wisps is dolt-ignored, so the main-plane ALTER never runs on a fresh
clone. Ships with the ignored-series twin ignored/0026, per check D of
scripts/check-migration-hygiene.sh (precedent ignored/0020 for 0060,
whose absence is how wisps.storage_class missed every fresh clone).
2. Raw-SQL idempotence for the ADD COLUMNs, and the Go-side guard
removed as redundant. internal/storage/dolt/pr4107_corruption_test.go
replays the frozen .up.sql bytes from 0046 onward straight through the
driver onto an already-migrated store, so nothing in
internal/storage/schema is in that path: every migration >= 0046 has
to be idempotent as raw SQL on its own, and execMigration0067Body
could never have covered it. schema.go is back at origin/main.
The guard is now an INFORMATION_SCHEMA-probed PREPARE per plane, the
0060/0066 shape. Dolt accepts no unprepared conditional DDL that would
do the same job — ADD COLUMN IF NOT EXISTS, DROP COLUMN IF EXISTS and
a top-level IF are all parse errors, and a stored procedure's body
needs a client-side DELIMITER that the CLI batch path requires and the
Go driver rejects, so one frozen file cannot satisfy both.
A PREPARE'd ADD COLUMN vanishes on the pre-2.3 CLI bundle path
(dolthub/dolt#11345), so it gets the same direct-DDL override
0060/0065/0066 use: cliMigration0067AddVersionedBeadsSchema, listed in
cliSubstituteAssumesWispTables because its wisps ALTER is unguarded.
New TestMigration0067ReplaysIdempotentlyAsRawSQLThroughPR4107Harness
proves it through that harness rather than a hand-written double-apply:
runMigrationSQLFilesFrom(..., "../schema/migrations", 46) twice, asserting
the columns stay single, a seeded current_revision survives (a
drop-and-re-add would pass a mere existence check while resetting rows),
and the tables are not recreated.
* review: pin 0067's wisps table-exists sub-guard and scope the rollback hazard
Maintainer review fixes for #6304 (Phase 1 versioned-beads schema). All three
are non-gating findings from the review synthesis; the scorecard approved with
no required changes.
- migration_0067_versioned_beads_test.go: pin the wisps arm's table-exists
sub-guard. It was neither executed nor string-pinned by any test — the
full-chain test seeds bounded at v46 and 0047's repair recreates wisps
before 0067's frozen text runs, so the arm never fires against an absent
wisps table anywhere in the suite. The pin is on the INFORMATION_SCHEMA
.TABLES probe rather than the suggested "TABLE_NAME = 'wisps'" literal:
that literal also matches the adjacent COLUMNS probe, so it stays green
after the sub-guard is dropped. Verified counterfactually — with the
table-exists arm removed, the TABLES pins fail and the literal still
matches.
- 0067_*.down.sql: the header claimed the pre-2.3 PREPARE hazard "never
reaches this file" because only migrations/*.up.sql is embedded. True of
the bundle, but a rollback file's consumer is a manual operator, and
`dolt sql -f` on a pre-2.3 CLI reports success while dropping both tables
and silently keeping both current_revision columns (dolthub/dolt#11345).
Scope the claim to the bundle and steer manual rollback to a server
connection or dolt >= 2.3. The Phase-1 "not a data-loss concern" sentence
is accurate and is left alone; Phase 2 (#6135) revisits it. Same scoping
applied to the identical claim in the test's down-side comment.
- initschema_0067_versioned_beads_replay_test.go: the doc comment cited
TestPR4107Migration0067ReplaysIdempotentlyAsRawSQL, which does not exist.
Corrected to TestMigration0067ReplaysIdempotentlyAsRawSQLThroughPR4107Harness.
Comment/test-only; no migration semantics change.
---------
Co-authored-by: quad341 <quad341@users.noreply.github.com>
Co-authored-by: Eddie the Engineer <julianknutsen@users.noreply.github.com>
|
||
|---|---|---|
| .agent/workflows | ||
| .beads/formulas | ||
| .claude | ||
| .claude-plugin | ||
| .devcontainer | ||
| .githooks | ||
| .github | ||
| backend | ||
| beadserrors | ||
| cmd/bd | ||
| docs | ||
| engdocs | ||
| examples | ||
| format | ||
| integrations | ||
| internal | ||
| issueops | ||
| journalops | ||
| memoryops | ||
| npm-package | ||
| plugins/beads | ||
| release-gates | ||
| schema | ||
| scripts | ||
| test | ||
| tests | ||
| tools/docsmint | ||
| winget | ||
| .buildflags | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| .pre-commit-config.yaml | ||
| .test-skip | ||
| AGENT_INSTRUCTIONS.md | ||
| AGENTS.md | ||
| ARTICLES.md | ||
| beads.go | ||
| beads_cgo.go | ||
| beads_gated_test.go | ||
| beads_nocgo.go | ||
| beads_test.go | ||
| BENCHMARKS.md | ||
| build-docs.md | ||
| CHANGELOG.md | ||
| claim.go | ||
| claim_roundtrip_test.go | ||
| claim_test.go | ||
| CLAUDE.md | ||
| codecov.yml | ||
| CONTRIBUTING.md | ||
| CONTRIBUTING_PR_GUIDELINES.md | ||
| default.nix | ||
| errors_test.go | ||
| export_dependency_add_options_test.go | ||
| FEDERATION-SETUP.md | ||
| flake.lock | ||
| flake.nix | ||
| go.mod | ||
| go.sum | ||
| install.ps1 | ||
| issue_lifecycle_external_test.go | ||
| issue_roles_external_test.go | ||
| issues.jsonl | ||
| LICENSE | ||
| Makefile | ||
| mint.sh | ||
| NEWSLETTER.md | ||
| open_backend_selection_test.go | ||
| open_nocgo_test.go | ||
| overlay.nix | ||
| packages.nix | ||
| PR_MAINTAINER_GUIDELINES.md | ||
| PROPOSAL-cas-conditional-update.md | ||
| PROPOSAL-pluggable-storage-backends.md | ||
| PROPOSAL-pull-config-wedge.md | ||
| query_interfaces_cgo_test.go | ||
| query_interfaces_test.go | ||
| README.md | ||
| RELEASING.md | ||
| renovate.json | ||
| SECURITY.md | ||
| THIRD_PARTY_LICENSES | ||
bd - Beads
Distributed graph issue tracker for AI agents, powered by Dolt.
Platforms: macOS, Linux, Windows, FreeBSD
Docs: https://beads.gascity.com/
Beads provides a persistent, structured memory for coding agents. It replaces messy markdown plans with a dependency-aware graph, allowing agents to handle long-horizon tasks without losing context.
flowchart LR
create["bd create<br/>new bead"] --> depgraph["dependency<br/>graph"]
depgraph --> ready["bd ready<br/>claimable work"]
ready --> claim["bd update --claim<br/>agent takes it"]
claim --> close["bd close<br/>work done"]
close -->|blockers released| ready
depgraph <-->|"bd dolt push / pull"| remote[("other machines<br/>and agents")]
⚡ Quick Start
# Install beads CLI (system-wide - don't clone this repo into your project)
curl -fsSL https://raw.githubusercontent.com/gastownhall/beads/main/scripts/install.sh | bash
# Initialize in YOUR project
cd your-project
bd init
# Optional: refresh or install richer instructions for your agent
bd setup codex # Codex CLI - installs skill, AGENTS.md guidance, and hooks
bd setup claude # Claude Code - installs hooks/settings
bd setup factory # Factory.ai Droid - creates/updates AGENTS.md
Note: Beads is a CLI tool you install once and use everywhere. You don't need to clone this repository into your project.
bd init creates or updates AGENTS.md by default so agents can discover the beads workflow, and also installs project Claude/Codex integrations unless you pass --skip-agents or --stealth. Use bd setup --list to see supported integrations, including bd setup codex, bd setup factory, bd setup claude, bd setup mux, bd setup cursor, and more. See Agent and IDE setup.
Manual copy-paste is only for unsupported agents, existing projects where you cannot rerun bd init/bd setup, or custom instruction files. In those cases, run bd onboard and paste the printed snippet into the file your agent reads.
If your agent is not covered by bd setup, add this minimal AGENTS.md section:
This project uses bd (beads) for issue tracking.
- Run `bd prime` for workflow context and command guidance.
- Use `bd ready`, `bd show <id>`, `bd update <id> --claim`, and `bd close <id>`.
- Use `bd remember "insight"` for persistent project memory; do not create MEMORY.md files.
- Do not use markdown TODO lists for task tracking.
🛠 Features
- Dolt-Powered: Version-controlled SQL database with cell-level merge, native branching, and built-in sync via Dolt remotes.
- Agent-Optimized: JSON output, dependency tracking, and auto-ready task detection.
- Zero Conflict: Hash-based IDs (
bd-a1b2) prevent merge collisions in multi-agent/multi-branch workflows. - Compaction: Semantic "memory decay" summarizes old closed tasks to save context window.
- Messaging: Message issue type with threading (
--thread), ephemeral lifecycle, and mail delegation. - Graph Links:
relates-to,duplicates,supersedes, andreplies-tofor knowledge graphs.
📖 Essential Commands
| Command | Action |
|---|---|
bd ready |
List tasks with no open blockers. |
bd create "Title" -p 0 |
Create a P0 task. |
bd update <id> --claim |
Atomically claim a task (sets assignee + in_progress). |
bd dep add <child> <parent> |
Link tasks (blocks, related, parent-child). |
bd show <id> |
View task details and audit trail. |
bd prime |
Print agent workflow context and persistent memories. |
bd remember "insight" |
Store project memory that bd prime injects later. |
🔗 Hierarchy & Workflow
Beads supports hierarchical IDs for epics:
bd-a3f8(Epic)bd-a3f8.1(Task)bd-a3f8.1.1(Sub-task)
Stealth Mode: Run bd init --stealth to use Beads locally without committing files to the main repo. Perfect for personal use on shared projects. See Git-Free Usage below.
Contributor vs Maintainer: When working on open-source projects:
- Contributors (forked repos): Run
bd init --contributorto route planning issues to a separate repo (e.g.,~/.beads-planning). Keeps experimental work out of PRs. - Maintainers (write access): Beads auto-detects maintainer role via SSH URLs or HTTPS with credentials. Only need
git config beads.role maintainerif using GitHub HTTPS without credentials but you have write access.
📦 Installation
brew install beads # macOS / Linux (recommended)
npm install -g @beads/bd # Node.js users
Other methods: install script | go install | from source | Windows | Arch AUR
Requirements: macOS, Linux, Windows, or FreeBSD. See docs/getting-started/installation.md for complete installation guide.
Upgrading? Replacing the binary is not always the whole story. Short
version: sync remote-backed databases with your current bd, back up with
bd export --all, upgrade the binary, then run bd info --whats-new,
bd hooks install, and bd version. If the upgrade crosses a schema
migration on a remote-backed database, exactly one designated clone runs
bd migrate and bd dolt push; other clones install the new binary
and run bd bootstrap. See the full
upgrade guide
or docs/getting-started/installation.md.
Security And Verification
Before trusting any downloaded binary, verify its checksum against the release checksums.txt.
The install scripts verify release checksums before install. For manual installs, do this verification yourself before first run.
On macOS, scripts/install.sh preserves the downloaded signature by default. Local ad-hoc re-signing is explicit opt-in via BEADS_INSTALL_RESIGN_MACOS=1.
See docs/reference/antivirus.md for Windows AV false-positive guidance and verification workflow.
💾 Storage Modes
Beads uses Dolt as its database. Two modes:
- Embedded (default) —
bd init. Dolt runs in-process, data lives in.beads/embeddeddolt/, single writer. Recommended for most users. - Server —
bd init --server. Connects to an externaldolt sql-serverfor multiple concurrent writers; data lives in.beads/dolt/.
Cross-machine sync uses bd dolt push / bd dolt pull against
refs/dolt/data on your git remote; .beads/issues.jsonl is an export for
viewers and interchange, not the source of truth or a backup. Back up and
migrate between modes with bd backup; reclaim space with bd prune /
bd purge.
Full detail — connection flags, sockets, maintenance, backup, and migration — in the Dolt backend guide.
Schema Version Guard
bd checks the database schema version at open time. If the database has been
migrated by a newer binary and an older binary tries to open it, bd exits
with an actionable error rather than issuing queries that fail with cryptic SQL
errors:
schema version mismatch: database is at v45, binary knows up to v42 (3 migrations ahead)
Your bd binary is stale. Queries for dropped or renamed columns will fail
with cryptic SQL errors (e.g. "column X could not be found in any table in scope").
Rebuild from main:
CGO_ENABLED=0 go build -tags gms_pure_go ./cmd/bd
Or install the latest release:
CGO_ENABLED=0 go install -tags gms_pure_go github.com/steveyegge/beads/cmd/bd@latest
To proceed despite the risk (some read commands may still work):
BD_IGNORE_SCHEMA_SKEW=1 bd <command>
bd --ignore-schema-skew <command>
When this fires: only when the database schema is ahead of the binary (a newer binary migrated the database; this binary doesn't know those migrations). Normal upgrades, where the binary migrates the database forward, are unaffected.
Escape hatch: BD_IGNORE_SCHEMA_SKEW=1 (or --ignore-schema-skew) bypasses
the guard with a warning on stderr. Use this only if you know the forward
migrations are additive and safe for your specific workload.
🌐 Community Tools
See docs/community-tools.md for a curated list of community-built UIs, extensions, and integrations—including terminal interfaces, web UIs, editor extensions, and native apps.
See docs/related-projects.md for adjacent or complementary projects that solve different problems in the same neighborhood.
🚀 Git-Free Usage
Beads works without git. The Dolt database is the storage backend — git integration (hooks, repo discovery, identity) is optional.
# Initialize without git
export BEADS_DIR=/path/to/your/project/.beads
bd init --quiet --stealth
# All core commands work with zero git calls
bd create "Fix auth bug" -p 1 -t bug
bd ready --json
bd update bd-a1b2 --claim
bd prime
bd close bd-a1b2 "Fixed"
BEADS_DIR tells bd where to put the .beads/ database directory,
bypassing git repo discovery. --stealth sets no-git-ops: true in
config, disabling all git hook installation and git operations.
This is useful for:
- Non-git VCS (Sapling, Jujutsu, Piper) — no
.git/directory needed - Monorepos — point
BEADS_DIRat a specific subdirectory - CI/CD — isolated task tracking without repo-level side effects
- Evaluation/testing — ephemeral databases in
/tmp