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 c185735c38
release: prep v1.3.0-rc.2 (#6298)
* release: prep v1.3.0-rc.2

Sanctioned RC bump per RELEASING.md "Cut an RC":
./scripts/update-versions.sh 1.3.0-rc.2

The Windows PE numeric fields (winres file_version/product_version and
the manifest <assemblyIdentity> version) stay at the base version 1.3.0
because PE versions must be purely numeric; the FileVersion/ProductVersion
strings carry the full 1.3.0-rc.2, and uv.lock carries the PEP 440
normalization 1.3.0rc2. scripts/check-versions.sh passes all 24 gates.

Also adds the three user-facing fixes found by testing rc.1 against
gascity to the [1.3.0] Fixed section: #6118 (an env-pointed server was
classified as workspace-owned, bypassing the shared-store migrate gate),
#6119 (a config.yaml server-mode workspace was refused as legacy), and
#6120 (a metadata-less server-mode workspace opened a phantom embedded
database and returned a false-empty list). #6121 is CI-only and takes no
changelog entry, matching #6091.

The [1.3.0] date is deliberately left alone — the stamp-changelog step
owns it at final-release time.

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

* fix(release): complete the rc.2 rollup and add the info.go RC digest

Review fixups on top of the rc.2 prep. Two release-notes surfaces were
incomplete for this PR's own commit range, which grew when the prep patch
was rebased onto a base that already shipped #6269.

CHANGELOG rollup (gating). The `bd ready --claim` row-cap refusal sits under
`[Unreleased]`, which by Keep-a-Changelog semantics means it ships in no
release — but `git merge-base --is-ancestor 24a9da6cc HEAD` says rc.2 ships
the behavior, and it is the only breaking change in the range. Moved it into
`[1.3.0] ### Changed`, leaving `[Unreleased]` empty exactly as it was at the
`v1.3.0-rc.1` tag, and tagged it `(#6269)` so the rollup audit RELEASING.md
prescribes can identify its commit. This is the verbatim Release Checklist
item at RELEASING.md:150-153; `cmd/bd/info.go:227` points users at "the
[1.3.0] section", so section placement is the authoritative surface.

info.go digest. `versionChanges` had no RC entry, so `bd upgrade review` and
`bd info --whats-new` never surfaced #6118/#6119/#6120 to a 1.2.2 upgrader,
and the stale `1.3.0` SHARED SERVER item describes the #5920/#6048 gate
without the #6118 bypass fix. Added a `1.3.0-rc.2` entry per the
`1.1.0-rc.2` precedent (info.go:282), covering the three fixes plus the
ready-claim change, per RELEASING.md:154 and "Cut an RC" step 1. This also
stops the unknown-`since` fallback from dumping the whole release history at
an rc.2 user. Known residual: `1.3.0-rc.1` still has no entry, so an
rc.1->rc.2 upgrader keeps hitting that fallback; pre-existing, out of scope
for this bump.

Correction to the prep commit message: "the stamp-changelog step owns [the
CHANGELOG date] at final-release time" is not what that step does.
`.beads/formulas/beads-release.formula.toml:428-440` sed-inserts a new
`## [{{version}}] - $DATE` header beneath `## [Unreleased]`; it never
re-dates an existing section. With `## [1.3.0] - 2026-08-28` already dated,
running it at final release produces a duplicate `## [1.3.0]` heading. Final
1.3.0 prep must hand-restamp instead, or that step needs fixing first.

Validated: ./scripts/check-versions.sh 24/24 at 1.3.0-rc.2; go build/vet
./cmd/bd; go test ./cmd/bd -run
'TestVersionChanges|TestGetVersionsSince|TestDisplayVersion'; git diff
--check clean; `[Unreleased]` confirmed empty.

* docs(recovery): re-review init-safety playbooks; refresh the 90-day marker (#6411)

* docs(recovery): re-review init-safety playbooks; refresh the 90-day marker

The Last-reviewed marker crossed the 90-day freshness threshold on Sep 7,
turning 'Check doc flags freshness' (and with it PR Policy and the required
CI Gate) red for EVERY open PR — #6262 is merge-queued and UNSTABLE on
exactly this.

Reviewed against the declared freshness sources (init.go, init_safety.go,
init_safety_test.go, dolt.go), which changed materially since June
(notably the destructive-preflight replacement in #5310 and the
server-flag precedence work): the four playbooks' premises still hold —
--destroy-token/--reinit-local/--discard-remote all exist and are the
refusal remedies, the force-refusal-on-origin-history invariant is intact,
and the pk-fork-refused deep link from dolt.go:416 resolves. One drift
noted, not a correctness issue: the three init-* anchors are no longer
deep-linked from refusal messages post-#5310 (bd help init-safety links
the doc generically); a fuller playbook revalidation against the new
preflight wording is follow-up material, not a blocker.

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

* docs(recovery): correct the init-safety exit-code mapping under the renewed marker

Maintainer review fixup for #6411. The marker bump renews a 90-day freshness
warranty asserting the four playbooks' premises still hold; review found one
that does not, so fix it rather than reset the clock over it.

init-local-exists was headed `Exit code: 11 (ExitLocalExistsRefused)` but led
with the "Refusing to destroy N issues in non-interactive mode." symptom,
which returns 12 (ExitDestroyTokenMissing, cmd/bd/init.go:2712-2715). Exit
11's only non-test site is the interactive typed-confirm decline
(cmd/bd/init.go:2696) — the same split cmd/bd/protocol/exit_codes_init_test.go
already documents. The section's recovery (`bd init --reinit-local`) also
dead-ended: runInitReinitPreflight gates on reinitLocal alone, so the
non-interactive caller the symptom names re-triggers the identical exit-12
refusal.

- doc: head init-local-exists with both codes, lead with the true exit-11
  interactive symptom, append --destroy-token to the non-interactive recovery,
  and add the refusal as a second symptom under init-token-missing, whose
  "Why this happens" attributed the token to --discard-remote alone.
- doc: scope the intro's "points here to a labeled anchor" claim to the
  post-#5310 reality the marker commit itself disclosed (only pk-fork-refused
  is still deep-linked).
- code: correct the ExitLocalExistsRefused and ExitDestroyTokenMissing
  comments, which are where the doc inherited its mapping error from, and
  widen the same --discard-remote-only framing in `bd help init-safety`.
- gate: add cmd/bd/dolt.go to check-doc-freshness.sh — the doc declares it a
  freshness source but the script did not enforce it, so drift in the pk-fork
  playbook's source never tripped the re-review duty.

Comment, doc, and help text only; no behavior change. Verified:
check-doc-freshness.sh PASSED 10/10 with the added source, go test ./scripts/,
the cmd/bd init-safety tests, and the cmd/bd/protocol exit-code contract tests.

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

* fix(ci): sync the doc-freshness test fixture with the init-safety source list

The maintainer review fixup for #6411 added `cmd/bd/dolt.go` to the
`docs/recovery/init-safety.md` entry of the DOCS array in
scripts/check-doc-freshness.sh (and to the doc's own `Freshness source:`
marker), but scripts/check_doc_freshness_test.go pins the same list in
`freshnessDocuments`, which it uses to build the fixture tree every
subtest runs the real script against. The fixture doc's marker line is
written from that pinned list, so the script -- correctly -- reported
`FAIL: Freshness source does not name cmd/bd/dolt.go` for every case.

That reds `.github/workflows/pr.yml`'s check-doc-freshness-platforms
matrix, which runs
`go test '-tags=integration,gms_pure_go' -count=1 -run '^TestDocFreshness' ./scripts`.
GitHub CI never saw it: the six workflows are green on the pushed head
94d76b5a4, which is the one-line marker bump alone, while the fixup that
edits the DOCS array has been local-only through the review loop.

Add `cmd/bd/dolt.go` to the pinned list so the mirror matches the script.

Validated in the adopted worktree:
- `go test '-tags=integration,gms_pure_go' -count=1 -run '^TestDocFreshness' ./scripts` -> ok
  (fails without this commit; passes at 94d76b5a4, so the break is fixup-introduced)
- `./scripts/check-doc-freshness.sh` -> PASSED against the real tree
- `go build ./...`, `go vet ./cmd/bd/... ./scripts/...` -> clean
- `go test ./test/docsync` (Mintlify nav/link guard) -> ok
- `go test ./cmd/bd/protocol -run Exit` -> ok
- the 14 `cmd/bd/init_safety_test.go` tests -> ok

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

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>

* fix(release): key rc.1 in versionChanges; admit exit 12's interactive decline

Maintainer review fixups for the v1.3.0-rc.2 prep adoption. Both findings
are minor and non-gating; both are cheapest to fix before the tag.

versionChanges gained a 1.3.0-rc.2 key but has no 1.3.0-rc.1 key, so the
one upgrade hop this RC creates -- rc.1 testers (the reporters of
#6118-#6120) moving to rc.2 -- misses the exact-string index scan in
getVersionsSince and falls through to its "upgrading from a very old
version" branch, which returns the ENTIRE list. `bd upgrade review` then
dumps all 81 release entries instead of the one-entry rc.2 digest written
for exactly that audience -- while the shipped [1.3.0] entry tells users
to prefer it to `bd info --whats-new` "which dumps the whole release
history". The lookup runs in the NEW binary, so an rc.1 key can only
reach an rc.1 user by shipping inside rc.2; it cannot be added later.
The 1.1.0 line carries both of its rc keys (info.go:293,305) and this
restores that pattern. Placement is immediately below the rc.2 entry:
getVersionsSince cuts by index, and the 2026-08-31 date keeps the array
monotonic for TestGetVersionsSinceOrder. Verified with the built package:
getVersionsSince("1.3.0-rc.1") now returns exactly the rc.2 entry, and
the 1.2.2 hop still resolves, now as [1.3.0, rc.1, rc.2].

The ExitDestroyTokenMissing doc comment and the `bd help init-safety`
exit table say 12 means a destructive re-init "in non-interactive mode",
but handleRemoteSafetyDecision returns 12 from a branch guarded by
term.IsTerminal (cmd/bd/init.go:3147) when the interactive
--discard-remote typed-token confirmation is declined -- a third producer
alongside init.go:2744 and init_safety.go:162. A script or playbook
branching on "12 => we were non-interactive" can misdiagnose an
interactive decline. The clause is verbatim pre-existing, but the commit
it rides on re-audited exactly this exit-code documentation and made the
sibling exit-11 "sole source" claim exactly precise, so it is corrected
here rather than re-asserted. Both sites gain one clause.

Comment, help text, and release-metadata only; no behavior change and no
constant values changed. Verified: check-versions.sh in sync at
1.3.0-rc.2, check-doc-freshness.sh PASSED, gofmt clean, git diff --check
clean, and the cmd/bd version-tracking and init-safety tests green.

Follow-up (not this PR): no test pins the RC-key chain, which is how the
missing key passed CI silently; a presence-pin would close the class.

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

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-09-09 23:50:53 -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.2 (#6298) 2026-09-09 23:50:53 -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.2 (#6298) 2026-09-09 23:50:53 -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 release: prep v1.3.0-rc.2 (#6298) 2026-09-09 23:50:53 -07:00
docs release: prep v1.3.0-rc.2 (#6298) 2026-09-09 23:50:53 -07:00
engdocs test(proxy): topology-parameterized history and remote front-door matrix (#6269) 2026-09-05 08:25:49 -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.2 (#6298) 2026-09-09 23:50:53 -07:00
internal test(proxy): topology-parameterized history and remote front-door matrix (#6269) 2026-09-05 08:25:49 -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.2 (#6298) 2026-09-09 23:50:53 -07:00
plugins/beads release: prep v1.3.0-rc.2 (#6298) 2026-09-09 23:50:53 -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 release: prep v1.3.0-rc.2 (#6298) 2026-09-09 23:50:53 -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.2 (#6298) 2026-09-09 23:50:53 -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.2 (#6298) 2026-09-09 23:50:53 -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