Beads - A memory upgrade for your coding agent https://beads.gascity.com
  • Go 95.2%
  • Python 1.6%
  • Starlark 1.5%
  • Shell 1.3%
  • Rust 0.2%
Find a file
Julian Knutsen 62884bb87d
fix(storage): an env-pointed server is shared, not owned — close the migrate-gate bypass (#6118)
* fix(storage): an env-pointed server is shared, not owned — close the migrate-gate bypass

A workspace pointed at an externally-managed dolt sql-server purely through
BEADS_DOLT_SERVER_PORT was classified ServerModeOwned, so the shared-store
consent gate (#5920/#6048/#6055) never ran. bd then migrated that server's
database in place — no prompt, no warning, exit 0 — and every co-resident bd
still on the older schema was hard-refused with "schema version mismatch". The
gate added specifically to stop this had a hole straight through it.

The asymmetry. Two resolvers disagree about what names the server:

  - the CONNECTION path takes the env var first. configfile.GetDoltServerPort
    reads BEADS_DOLT_SERVER_PORT, then BEADS_DOLT_PORT, then metadata.json;
    doltserver's precedence chain behind ApplyResolvedServerPort does the same
    and records which step won as Config.ServerPortSource.
  - the OWNERSHIP path ignores it. ResolveServerMode's step 4 reads
    dolt_server_port from metadata.json ONLY.

So a workspace whose metadata.json says dolt_mode=server with no port, and
whose port arrives entirely from the environment, connects to a server it never
started while believing it owns a private one. Reproduced on a scratch server
shaped exactly like the reported deployment: identical topology, identical
database — with the port in metadata.json the gate refuses (exit 1); with the
same port supplied only by the env var, bd migrated v65 -> v66 silently
(exit 0). The only difference is where the port came from.

The fix. sharedServerDatabase stops borrowing the lifecycle resolver's answer
for a question it was not written to answer. ResolveServerMode's contract is
"may bd manage this server's lifecycle" — deliberately conservative about env
ports, because flipping it to External also disables auto-start. The gate needs
a stricter question, asked directly: did THIS workspace's own bookkeeping
produce the endpoint we connected to? Config.ServerPortSource already carries
the answer, stamped by applyConfigDefaults on every open, library path
included.

Workspace bookkeeping (owned): the port file doltserver.Start wrote, the dolt
config.yaml inside the workspace's own dolt dir, an in-process caller assertion
(be-wf9a.1), or no port resolved at all. Everything else — the env vars, beads'
config.yaml, metadata.json, the two documented fallback defaults — is an
operator writing down where a server already lives, and is shared. One escape
hatch: .beads/dolt-server.port naming the same port bd is connected on is bd's
own proof that it started that server, even when the env read won the chain.

Two neighbouring asymmetries in the same family, both found by auditing every
signal the connection path honors against what ownership resolution reads:

  - a gateway credential command mints a token for an authenticating server;
    bd's auto-start brings up a plain local root@localhost dolt and never
    issues tokens, so cfg.Gateway now asserts shared on its own rather than
    depending on port provenance.
  - applyResolvedConfig never copied dolt_server_socket out of metadata.json,
    although cmd/bd's resolveDoltServerConnection — which its own doc says it
    mirrors — always has. The library open path and the CLI therefore chose
    different transports for the same workspace, and it blinded the predicate's
    socket arm, which exists precisely because auto-start only ever creates a
    TCP listener. A configured-but-unreachable socket stays harmless:
    newServerMode normalizes it back to TCP via ResolveSocketTransport.

Not changed: ResolveServerMode itself, and so auto-start. Making an env-named
port imply External would also suppress auto-start, which is arguably right —
it is the shadow-database hazard External mode exists for — but it is a
behavior change on a path the reported blocker does not need, and this is an
RC. Left as a documented follow-up.

Why #6088's narrowing survives. Every check added here is an early `return
true`, so it can only ADD a shared classification, never remove one: any
topology gated before still returns at the same place. The auto-started
single-workspace server keeps every signal that made it owned — local host, no
TLS, no socket, not shared-server mode, ServerModeOwned — and now also resolves
its port from its own port file. TestServerModeLenientOpenDirtyTableGate, the
#4566/#5781 recovery whose whole shape is refuse-then-commit-then-migrate on
exactly such a server, passes unmodified; end to end, bd init --server on a
fresh workspace rolled back to v65 still migrates to v66 on the next write,
exit 0, no gate.

Tests: TestSharedServerDatabaseEndpointProvenance walks all nine port sources
plus the port-file hatch in both directions, the disagreeing-port-file case,
and the reported shape end to end (including an assertion that
ResolveServerMode still says Owned there — if that ever changes, the test has
stopped covering the bug). TestSharedServerDatabase gains the gateway case.
Reverting the new arm turns seven of them red, including the reported shape.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(storage): prove server ownership instead of inferring it from the endpoint

Review of the first cut found the bypass still open through two more doors, and
two false positives the "can only ADD shared" argument did not cover. All four
have the same cause: the predicate inferred ownership from how the endpoint was
NAMED, and every such inference is a separate silent bypass.

Still-open bypasses:

  - PortSourceCallerExplicit was treated as workspace bookkeeping, but
    applyConfigDefaults stamps it onto ANY caller-preset port, and
    `bd init --server-port` is the documented way to attach a workspace to an
    existing server. So `bd init --server-port 3307` against a shared server
    still resolved owned and migrated it in place, exit 0 — the reported
    failure through a different door. Same for any library embedder building
    dolt.Config{ServerHost: "127.0.0.1", ServerPort: 3307}.
  - the port-file escape hatch had no liveness check. A port file records that
    bd once bound a port, not that the process answering it now is bd's. A
    workspace whose own server died, with an external server later occupying
    that port, laundered the foreign endpoint into ownership. 3307 is both the
    common external port and bd's own default, so the collision is likely
    rather than exotic.

False positives:

  - PortSourceConfigYaml was classified shared, which hard-refuses a
    single-user workspace that pinned dolt.port in config.yaml with bd
    auto-starting its own server on it — the configuration bd's own auto-start
    warning tells users to adopt ("To pin a port: set dolt.port in
    .beads/config.yaml"). Newly-gated topologies are exactly where the #6088
    class of regression lives, and the additive argument says nothing about
    them.
  - reading dolt_server_socket in applyResolvedConfig disabled auto-start on
    the library path whenever the server was cold: ResolveSocketTransport
    returns the socket unchanged when neither socket nor TCP answers, and
    serverOpenCanAutoStart requires an empty socket. The claim that a
    non-connectable socket stays harmless held only while TCP was up — never in
    the case where auto-start matters.

So ownership is no longer inferred at all. doltserver.ManagesLiveServerOnPort
PROVES it from the state files bd writes when it starts a server: a live PID
beside a port file naming the port this store is actually connected on.
Everything else is shared. Enumerating the ways an endpoint can be foreign is
unbounded — an env var, a config.yaml pin, a flag, a hand-built Config, a stale
file all produce the same local TCP endpoint — while there is exactly one way
to be sure, and it is two cheap file reads and a signal 0.

That single rule closes both bypasses and removes both false positives: the
config.yaml pin and the env port bd itself bound both carry the proof, because
bd started those servers.

ManagesLiveServerOnPort deliberately stops short of IsRunning. IsRunning
repairs as it goes (deletes stale state, can stop an orphan), and a predicate
classifying a connection must not mutate workspace state as a side effect. It
also omits IsRunning's isDoltProcess() command-name check, which shells out to
`ps` — measured at 765ms on a loaded machine, and this runs on every writable
open. The residual gap needs a recycled PID AND a stale port file AND a foreign
server on that same port; strictly narrower than the gap left by trusting the
port file alone, and documented at the definition.

Also dropped: the cfg.Gateway arm, which was unreachable — newServerMode only
calls initSchema when !cfg.Gateway, so a gateway config never reaches this
predicate. It was listed as a closed asymmetry in the PR body and closed
nothing.

The socket read in applyResolvedConfig is reverted entirely: besides breaking
cold auto-start it never armed the predicate it was written for, because
newServerMode overwrites cfg.ServerSocket with the normalized transport before
initSchema runs. open.go is byte-identical to the base branch again. The
socket topology is covered by the ownership proof instead, without touching the
transport.

Tests: TestManagesLiveServerOnPort covers the proof directly, including that it
does not mutate the state it reads. TestSharedServerDatabaseOwnershipProof
replaces the port-source matrix — three of whose nine rows asserted
source/host combinations that cannot coexist in production — with the real
topologies, both bypasses among them. TestSharedServerDatabaseThroughResolvedConfig
drives applyResolvedConfig + applyConfigDefaults so the link between
BEADS_DOLT_SERVER_PORT and the classification is pinned by behavior rather than
by a hand-stamped field. The duplicated workspace/env helpers are hoisted to
package level, one env list.

Verified end to end on a scratch server for both new bypasses: the previous
build migrated v65 -> v66 exit 0 through each door; this one refuses both. The
#6088 auto-start case still migrates on open, exit 0.

Refs #6123 for the four-resolver reconciliation this defers.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs(doltserver): name the adopted-server residual gap in the ownership proof

Maintainer review fixup for PR #6118.

`ManagesLiveServerOnPort`'s doc stated the invariant as "a workspace whose
server bd brought up", but `Start()` writes the same PID and port files for a
server it *adopts*: `reclaimPort` returns the PID of a dolt process whose CWD
is this workspace's dolt dir, and `Start` records that foreign PID before
reporting `Running`. An operator running `dolt sql-server` over `.beads/dolt`
under systemd and then typing `bd dolt start` mints the proof for a server bd
does not manage — a second, wider residual gap than the recycled-PID one the
doc named, and one an auditor was told did not exist.

Comment-only. Soften the stated invariant to "started — or adopted — for
itself", document both residual gaps explicitly (adopted-server is unix-only
in practice: `isProcessInDir` is false on Windows), and point both at #6123,
which owns reconciling the four resolvers.

Deliberately not changed: no `isDoltProcess` check in the helper — it would
close only the recycled-PID gap, since `reclaimPort` already requires
`isDoltProcess` before adopting, at hundreds of ms on every writable open. And
no change to `Start`'s adopt branch: recording adoption distinctly is the right
fix but is a behavior change on the auto-start path, not an RC gate-hardening
patch. Both are tracked in #6123.

Neither gap is a regression: at base both topologies resolved `ServerModeOwned`
and were ungated, and `store.go` is +35/-0 with the new check as an early
return ahead of base's unchanged final return, so this PR can only add
refusals.

* docs(doltserver): the adopted-server gap is incidental and permanent

Amend the ManagesLiveServerOnPort ownership-proof comment so the residual
adopted-server gap is described the way it actually behaves: typing
`bd dolt start` is not required (a 500 ms dial timeout reaches the same
adopt branch with no operator action), the two state files the adopt
branch writes persist, and `dolt.auto-start: false` /
BEADS_DOLT_AUTO_START=0 is the one setting that closes the incidental
route while #6123 is open — the deliberate `bd dolt start` route is not
affected by it.

Also rename the positive proof subtest to say what it pins: any live PID
beside an agreeing port file is accepted, dolt process or not. The PID it
writes is the test binary's own, which parseDoltProcessPIDs would never
match, so the subtest is the live demonstration of the liveness-only
contract and is expected to go red when #6123 tightens the predicate.

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-09-04 23:37:32 -07:00
.agent/workflows docs: replace bd sync with bd dolt push/pull in agent instructions (GH#2563) 2026-03-13 11:01:06 -07:00
.beads/formulas release: prep v1.3.0 — version bump, changelog rollup, release process docs, formula fixes (#6038) 2026-08-30 22:19:35 -07:00
.claude test: reconcile the sqlite-era tests the reapply left asserting live support 2026-07-18 02:43:57 +00:00
.claude-plugin release: prep v1.3.0-rc.1 (#6090) 2026-08-31 00:47:46 -07:00
.devcontainer docs: move internal/maintainer docs from docs/ to engdocs/ 2026-07-12 10:37:07 -07:00
.githooks release: prep v1.3.0-rc.1 (#6090) 2026-08-31 00:47:46 -07:00
.github ci(macos): give the macOS test lane the 30m timeout the Linux lane already has (#6121) 2026-09-02 17:15:46 -07:00
backend fix(contracts): JSON contract fixes before 1.3.0 freezes them — string revision tokens, --set-metadata scalar typing, create --json nano timestamps (#6053) 2026-08-29 05:20:27 +00:00
beadserrors chore(api): mark new exported packages experimental before v1.3.0 (#6036) 2026-08-29 16:01:30 -07:00
cmd/bd fix(guard): a config.yaml server-mode workspace is not a legacy workspace (#6119) 2026-09-04 23:35:38 -07:00
docs release: prep v1.3.0 — version bump, changelog rollup, release process docs, formula fixes (#6038) 2026-08-30 22:19:35 -07:00
engdocs feat(httpapi): serve bd list's order with sort on listIssues (#5666) 2026-08-27 09:21:12 -07:00
examples security: v1.3.0 dependency + toolchain bumps (7 reachable stdlib advisories, criticals triaged) (#6047) 2026-08-28 23:26:04 -07:00
format fix(ui): stop using blocked ● for priority in CLI output (#5511) 2026-08-10 06:19:51 -07:00
integrations release: prep v1.3.0-rc.1 (#6090) 2026-08-31 00:47:46 -07:00
internal fix(storage): an env-pointed server is shared, not owned — close the migrate-gate bypass (#6118) 2026-09-04 23:37:32 -07:00
issueops chore(api): mark new exported packages experimental before v1.3.0 (#6036) 2026-08-29 16:01:30 -07:00
journalops chore(api): mark new exported packages experimental before v1.3.0 (#6036) 2026-08-29 16:01:30 -07:00
memoryops chore(api): mark new exported packages experimental before v1.3.0 (#6036) 2026-08-29 16:01:30 -07:00
npm-package release: prep v1.3.0-rc.1 (#6090) 2026-08-31 00:47:46 -07:00
plugins/beads release: prep v1.3.0-rc.1 (#6090) 2026-08-31 00:47:46 -07:00
release-gates fix(dolt): purge dropped databases in bench-store cleanup, with a regression gate (#5792) 2026-08-24 14:05:03 -07:00
schema chore(api): mark new exported packages experimental before v1.3.0 (#6036) 2026-08-29 16:01:30 -07:00
scripts ci(macos): give the macOS test lane the 30m timeout the Linux lane already has (#6121) 2026-09-02 17:15:46 -07:00
test chore(api): mark new exported packages experimental before v1.3.0 (#6036) 2026-08-29 16:01:30 -07:00
tests fix: TestMain teardown was dead code after os.Exit — 101 dolt containers leaked over 6 days (#5876) 2026-08-20 06:06:32 -07:00
tools/docsmint test(docsmint): make missing staging path portable (#5076) 2026-07-28 09:01:56 -07:00
winget docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
.buildflags chore: purge deleted docs-pipeline references from release tooling, CI, and repo plumbing 2026-07-12 11:07:26 -07:00
.gitattributes build: make repository text EOL deterministic (#5319) 2026-08-10 20:48:09 -07:00
.gitignore refactor(cli): rename CPU profiling flag (#5126) 2026-07-28 22:17:13 -07:00
.golangci.yml Retire the last three wisp-switch call sites, and bound the wisp-inclusive union reads (ga-2ltro.12, ga-2ltro.7) (#5587) 2026-08-10 17:07:59 -07:00
.goreleaser.yml fix(release): branch install header for prerelease vs stable (#4530) 2026-07-01 22:59:50 -07:00
.pre-commit-config.yaml fix: detect Go version mismatch in pre-commit hook before golangci-lint panics (bd-66nc) 2026-03-02 18:50:29 -08:00
.test-skip fix: rewrite TestRepairMultiplePrefixes for Dolt rename semantics (bd-alk64) 2026-02-14 11:05:39 -08:00
AGENT_INSTRUCTIONS.md fix(ui): stop using blocked ● for priority in CLI output (#5511) 2026-08-10 06:19:51 -07:00
AGENTS.md fix(ui): stop using blocked ● for priority in CLI output (#5511) 2026-08-10 06:19:51 -07:00
ARTICLES.md fix(docs): remove stale --branch flag and SQLite refs from QUICKSTART (GH#2522) (#2525) 2026-03-11 12:54:30 -07:00
beads.go fix(storage): shared stores refuse version-bump migration without explicit consent (#5920, #5043) (#6048) 2026-08-29 21:47:24 -07:00
beads_cgo.go fix(storage): truthful legacy-backend tombstone rejection — detect present Dolt data, give the exact heal (D-8) (#6044) 2026-08-28 23:27:39 -07:00
beads_gated_test.go feat(workspacegate): shared physical-root resolver, beads.OpenGated, and CLI gate wiring (part 2) (#5093) 2026-07-31 01:41:20 -07:00
beads_nocgo.go fix(storage): truthful legacy-backend tombstone rejection — detect present Dolt data, give the exact heal (D-8) (#6044) 2026-08-28 23:27:39 -07:00
beads_test.go fix: TestMain teardown was dead code after os.Exit — 101 dolt containers leaked over 6 days (#5876) 2026-08-20 06:06:32 -07:00
BENCHMARKS.md test: add perf reference benchmarks (#4032) 2026-05-19 18:39:13 -07:00
build-docs.md fix: correct brew commands and remove dead homebrew CI job 2026-02-09 08:02:42 +01:00
CHANGELOG.md release: prep v1.3.0-rc.1 (#6090) 2026-08-31 00:47:46 -07:00
claim.go feat(issueops): put every issue capability behind one library surface 2026-08-04 12:27:56 -07:00
claim_roundtrip_test.go feat(storage): events + dependents reads, batched blocked, public claim surface (#4926) 2026-07-22 07:41:47 -07:00
claim_test.go feat(storage): events + dependents reads, batched blocked, public claim surface (#4926) 2026-07-22 07:41:47 -07:00
CLAUDE.md docs: move internal/maintainer docs from docs/ to engdocs/ 2026-07-12 10:37:07 -07:00
codecov.yml test: improve coverage signal policy (#4219) 2026-05-27 22:05:14 -07:00
CONTRIBUTING.md docs(lint): align contributor guidance with CI (saa-90w) (#5317) 2026-08-07 05:37:12 -07:00
CONTRIBUTING_PR_GUIDELINES.md docs: add CONTRIBUTING_PR_GUIDELINES.md (codify reviewer expectations for contributors) (#3913) 2026-07-06 22:12:29 -07:00
default.nix release: prep v1.3.0-rc.1 (#6090) 2026-08-31 00:47:46 -07:00
errors_test.go feat(issueops): name the two dependency-endpoint refusals (bd-yby99.9) 2026-08-07 19:45:54 +00:00
export_dependency_add_options_test.go feat: export DependencyAddOptions from the root package (#4870) 2026-07-17 20:34:32 -07:00
FEDERATION-SETUP.md chore: purge deleted docs-pipeline references from release tooling, CI, and repo plumbing 2026-07-12 11:07:26 -07:00
flake.lock flake.lock: Update (#4501) 2026-07-08 12:21:24 -07:00
flake.nix Guard and qualify historical upgrades to v1.2 (#4907) 2026-08-06 18:45:04 -07:00
go.mod security: v1.3.0 dependency + toolchain bumps (7 reachable stdlib advisories, criticals triaged) (#6047) 2026-08-28 23:26:04 -07:00
go.sum security: v1.3.0 dependency + toolchain bumps (7 reachable stdlib advisories, criticals triaged) (#6047) 2026-08-28 23:26:04 -07:00
install.ps1 docs: update user-facing URLs from steveyegge/beads to gastownhall/beads 2026-04-24 08:17:42 -07:00
issue_lifecycle_external_test.go feat(storage): one guarded issue-lifecycle surface for the CLI and linked consumers (#5191) 2026-07-31 11:26:38 -07:00
issue_roles_external_test.go Add issueops.GraphCounter: how many edges, in one named direction (ga-itny5) (#5485) 2026-08-09 11:29:32 -07:00
issues.jsonl ci: add nix build check to catch vendorHash drift (GH#3298) (#3364) 2026-04-20 13:21:53 -07:00
LICENSE Initial commit: Beads issue tracker with security fixes 2025-10-11 20:07:36 -07:00
Makefile security: v1.3.0 dependency + toolchain bumps (7 reachable stdlib advisories, criticals triaged) (#6047) 2026-08-28 23:26:04 -07:00
mint.sh chore: purge deleted docs-pipeline references from release tooling, CI, and repo plumbing 2026-07-12 11:07:26 -07:00
NEWSLETTER.md Retire legacy Homebrew tap publishing (#4478) 2026-06-22 19:26:46 -07:00
open_backend_selection_test.go fix(storage): truthful legacy-backend tombstone rejection — detect present Dolt data, give the exact heal (D-8) (#6044) 2026-08-28 23:27:39 -07:00
open_nocgo_test.go :remove uneccessary locking 2026-05-01 17:46:37 -07:00
overlay.nix feat(nix): expose packages as an overlay for downstream override (#3910) 2026-07-06 22:39:37 -07:00
packages.nix feat(nix): expose packages as an overlay for downstream override (#3910) 2026-07-06 22:39:37 -07:00
PR_MAINTAINER_GUIDELINES.md docs(maintainer): prior-art pass is part of every review; rebases are maintainer work (#5094) 2026-07-26 21:40:34 -07:00
PROPOSAL-cas-conditional-update.md fix(claim): verify claim-family writes by re-read under a degraded server (bd-zccb9) (#5006) 2026-07-24 07:21:24 -07:00
PROPOSAL-pluggable-storage-backends.md Reapply "Simplify the supported backends: roll back the direct PostgreSQL and MySQL adapters" (#4857) 2026-07-18 02:43:56 +00:00
PROPOSAL-pull-config-wedge.md fix(dolt): pre-pull commit must include config (kv.memory.* pull-wedge) (#4412) 2026-06-19 21:31:33 -07:00
query_interfaces_cgo_test.go feat(storage): events + dependents reads, batched blocked, public claim surface (#4926) 2026-07-22 07:41:47 -07:00
query_interfaces_test.go feat(storage): events + dependents reads, batched blocked, public claim surface (#4926) 2026-07-22 07:41:47 -07:00
README.md docs: schema-version guard in README and CHANGELOG (be-x0rl6) (#4161) 2026-07-23 19:13:38 -07:00
RELEASING.md release: prep v1.3.0 — version bump, changelog rollup, release process docs, formula fixes (#6038) 2026-08-30 22:19:35 -07:00
renovate.json chore: harden release and dependency security 2026-04-28 08:45:22 +00:00
SECURITY.md docs(ci): add Mintlify preview, docsync guard, and broken-links workflow 2026-07-12 10:37:07 -07:00
THIRD_PARTY_LICENSES revert: restore embedded Dolt mode (was only supposed to be removed from Gas Town) 2026-02-07 21:21:24 -08:00

bd - Beads

Distributed graph issue tracker for AI agents, powered by Dolt.

Platforms: macOS, Linux, Windows, FreeBSD

License Go Report Card Release npm version PyPI

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, and replies-to for 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 --contributor to 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 maintainer if 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 external dolt sql-server for 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_DIR at a specific subdirectory
  • CI/CD — isolated task tracking without repo-level side effects
  • Evaluation/testing — ephemeral databases in /tmp

📝 Documentation