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
Jim Wordelman 349e4b029f
fix(dolt): explicit ServerPort must outrank ambient BEADS_DOLT_SERVER_PORT env var (#5835)
* test(feat): red — Fix: explicit Config.ServerPort must outrank ambient BEADS_DOLT_SERVER_PORT env var (refs be-wf9a.1)

* feat: green — Fix: explicit Config.ServerPort must outrank ambient BEADS_DOLT_SERVER_PORT env var (refs be-wf9a.1)

* test(dolt): red — applyResolvedConfig must propagate ServerPortSource (refs be-9tju)

Four new subtests on TestApplyResolvedConfig pin down the reviewer's
security blocker: applyResolvedConfig (open.go:250-255) copies only
doltserver.DefaultConfig(beadsDir).Port into cfg.ServerPort, never
.PortSource/.PortSharedServer. Chained through applyConfigDefaults,
this mislabels any port-file-resolved port as PortSourceCallerExplicit
(the PortSourceUnset guard at store.go:1429 can't tell the difference),
which in turn makes the legacy BEADS_DOLT_PORT env-var override at
store.go:1439 a no-op — a regression of the hq-27t bug class.

Currently failing (RED), for the traced reasons:
- "propagates ServerPortSource...": ServerPortSource stays "" instead
  of "port_file".
- "chained through applyConfigDefaults...never mislabeled": comes out
  "caller_explicit" instead of "port_file".
- "legacy BEADS_DOLT_PORT redirects...": ServerPort stays the
  port-file value (14567) instead of following the env override
  (43211).

A fourth subtest ("genuinely caller-explicit ServerPort still
outranks ambient env") already passes today — it chains through the
same real applyResolvedConfig -> applyConfigDefaults integration path
that the reviewer flagged as uncovered (the existing
TestApplyConfigDefaults_* tests bypass applyResolvedConfig entirely
via a bare &Config{}), locking in that be-wf9a.1's original
caller-explicit-wins intent survives the upcoming fix.

* fix(dolt): green — propagate ServerPortSource so legacy port-env override isn't silently skipped (refs be-9tju)

Two-part fix for the request-changes security blocker on this branch:

1. internal/storage/dolt/open.go applyResolvedConfig: when ServerPort
   resolves via doltserver.DefaultConfig(beadsDir)'s fallback chain
   (env > port file > config.yaml > metadata), propagate the resolved
   .PortSource and .PortSharedServer alongside .Port — mirroring the
   pattern store.go's own fallback block already uses. Previously only
   .Port was copied, leaving ServerPortSource at its zero value
   (PortSourceUnset) even when the port came from an ambient/stored
   resolution like the port file.

2. internal/storage/dolt/store.go applyConfigDefaults: widen the legacy
   BEADS_DOLT_PORT / BEADS_DOLT_SERVER_PORT env-override gate from
   `cfg.ServerPort == 0` to `cfg.ServerPort == 0 ||
   !cfg.ServerPortSource.IsAuthoritative()`. Part 1 alone isn't
   sufficient: the gate only ever checked whether ServerPort was zero,
   independent of whether its source was actually caller-authoritative.

Without both parts, applyConfigDefaults's PortSourceUnset check
(`if cfg.ServerPort != 0 && cfg.ServerPortSource == PortSourceUnset {
cfg.ServerPortSource = PortSourceCallerExplicit }`) mislabeled a
port-file-resolved port as caller-explicit, which then made the legacy
env override a silent no-op for any normal (non-init) bd command
against an already-initialized project — a regression of the hq-27t
bug class, exactly as reported in be-9tju's rejection notes.

A genuinely caller-explicit ServerPort (e.g. bd init --server-port)
still outranks the ambient env var: applyResolvedConfig only stamps
PortSourceCallerExplicit when the caller preset ServerPort before the
call, and IsAuthoritative() is true for that source — covered by the
new "genuinely caller-explicit ... still outranks ambient env" subtest
committed in the RED step (4f4de51618).

Targeted test: go test ./internal/storage/dolt/... -run
TestApplyResolvedConfig -v — all 10 subtests (6 original + 4 new) pass.

Full suite: bash scripts/ci/pr-core.sh succeeded in 345s, zero FAILs,
including both packages that timed out on the prior rejected run
(cmd/bd 288.243s ok, internal/storage/embeddeddolt 255.521s ok) and
both packages this diff touches (internal/doltserver 5.045s ok,
internal/storage/dolt 9.520s ok). Log: /tmp/tdd-green-pr-core.log.

* docs(release-gates): record be-gd3v gate PASS (ServerPort precedence fix)

All 7 criteria clear: review PASS, tests green (-race, 0 skips),
lint clean, no blocking findings, clean tree, clean fast-forward off
origin/main, single theme. PR gastownhall/beads#5835 opened.

* fix(doltserver): stamp a PortSource on the shared-server default port

Review point 1 (blocking), part 1 of 2.

DefaultConfig filled in DefaultSharedServerPort (3308) when shared-server
mode is on and no source resolved a port, but left PortSource unset. That
made a bd-chosen port indistinguishable from a caller assertion: any site
copying DefaultConfig(...).Port into dolt.Config.ServerPort hands
applyConfigDefaults a nonzero port with PortSourceUnset, and the
"nonzero + unset => caller_explicit" inference (be-wf9a.1) stamps it
authoritative.

Add PortSourceSharedServerDefault -- deliberately NOT authoritative, since
bd picked it on the user's behalf exactly like the port file -- and record
it on that fill. TestDefaultConfig_NonzeroPortAlwaysHasSource pins the
invariant the inference depends on: DefaultConfig never returns a nonzero
Port with PortSourceUnset. Verified red before the fix (Port=3308 with
PortSourceUnset), green after.

Propagation at the remaining unthreaded call sites follows in part 2.

* fix(cmd/bd): propagate PortSource at the remaining unthreaded config sites

Review point 1 (blocking), part 2 of 2.

applyConfigDefaults infers "the caller explicitly asserted this port" from
"ServerPort nonzero, ServerPortSource unset" (be-wf9a.1). Round 2 closed
that gap in applyResolvedConfig, but four twin sites still copied
doltserver.DefaultConfig(dir).Port into a hand-built dolt.Config without
the source, so every port bd resolved for itself arrived labeled
authoritative:

  - cmd/bd/main.go resolveDoltServerConnection -- the primary CLI
    store-open path, and the connection `bd serve` builds
    (cmd/bd/uow_factory.go). Its own comment said it mirrors
    applyResolvedConfig; the mirror had gone out of sync.
  - cmd/bd/init.go initPort -- resolves from the env var, the port file,
    or the shared-server default 3308. None of the three is a caller
    assertion.
  - cmd/bd/init.go initGlobalDatabaseConfig -- copied ServerPort forward
    without its source.
  - cmd/bd/doctor/federation.go doltServerConfig.

Consequences, both user-visible: the legacy BEADS_DOLT_PORT override
became a silent no-op on the main CLI path while still working on the
library open path -- the two open paths disagreed on precedence -- and a
stale .beads/dolt-server.port after a crashed server made auto-start
hard-fail with "bd will not silently use a different port than the one you
configured" when the user had configured nothing (GH#4052).

Centralize rather than repeat the three-line copy a fifth time:
dolt.ApplyResolvedServerPort(beadsDir, cfg) resolves port, source and
shared-server flag together, and applyResolvedConfig now uses it too.
init.go keeps its own hand-rolled chain (it deliberately consults only
project-local sources, GH#2336) and tracks the source alongside; `bd init
--server-port` stamps PortSourceCallerExplicit itself, replacing rather
than inheriting the resolved source.

The shared-server default also sets ServerPortSharedServer, mirroring
DefaultConfig: if the shared server is down and auto-start brings up a
repo-local one, that is a different database, so newServerMode still fails
closed -- now with the accurate message instead of one blaming the user's
config.

Tests: TestApplyResolvedServerPort (+ chained through applyConfigDefaults)
and TestResolveDoltServerConnectionPropagatesPortSource assert the source
travels and, directly, that IsAuthoritative() is false for both port-file
and shared-default ports -- that predicate is what both consumers branch
on. Verified red before the fix (ServerPortSource = "" on the CLI path),
green after.

* docs(changelog): record the ServerPort precedence changes

Review point 2. Two deliberate user-visible precedence flips shipped
without a CHANGELOG entry: caller-explicit ServerPort now beats the ambient
port env vars, and the legacy BEADS_DOLT_PORT spelling no longer overrides
a port resolved from config.yaml, Dolt's listener.port, or metadata.json.
Both are intentional, so both are documented, with the migration for the
one workspace shape that changes behavior.

Also notes the GH#4052 failure that goes away with them -- a stale
.beads/dolt-server.port no longer makes auto-start refuse to start over a
port the user never configured -- since that is user-visible too.

Placed at the top of Unreleased/Changed rather than the end: main has been
appending after the existing entry, so inserting before it leaves that
block as common context and the two hunks merge without conflict.

* docs(release-gates): note the be-gd3v gate describes 2dbcbd7f2, not the head

Review point 3 (nit). The gate recorded headRefOid = 2dbcbd7f2 with "no
drift", but the commit adding the gate document was itself the first to
move the head past that SHA, so the claim contradicted itself the moment it
landed. Qualify the line as a snapshot and add a Post-gate history section
listing what has landed since -- including this review round, whose code
changes the criteria walk does not cover.

Corrected by annotation rather than by editing the verdict: the PASS is
still accurate about the SHA it examined.
2026-08-20 05:43:57 -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 chore: purge deleted docs-pipeline references from release tooling, CI, and repo plumbing 2026-07-12 11:07:26 -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 chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -07:00
.devcontainer docs: move internal/maintainer docs from docs/ to engdocs/ 2026-07-12 10:37:07 -07:00
.githooks chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -07:00
.github ci: PR-CI lane runs the full internal/storage/dolt suite against a live Dolt server (#5836) 2026-08-19 20:39:38 -07:00
backend fix: canonicalActor collapses the --/__ axes correctly; claim-verify uses ActorMatches (be-p7dzx, bundled be-vc51) (#5856) 2026-08-19 13:23:35 -07:00
beadserrors Move the namespace-neutral error vocabulary into its own leaf (#5395) 2026-08-07 04:32:06 -07:00
cmd/bd fix(dolt): explicit ServerPort must outrank ambient BEADS_DOLT_SERVER_PORT env var (#5835) 2026-08-20 05:43:57 -07:00
docs docs(troubleshooting): document the two native-Windows integration traps (#5838) 2026-08-20 05:41:39 -07:00
engdocs fix(doctor): recommend 'bd prune' instead of nonexistent 'bd cleanup' (#5829) 2026-08-20 05:30:47 -07:00
examples fix(examples): tidy both example modules and build them in CI (#5229) 2026-08-12 21:16:27 -07:00
format fix(ui): stop using blocked ● for priority in CLI output (#5511) 2026-08-10 06:19:51 -07:00
integrations chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -07:00
internal fix(dolt): explicit ServerPort must outrank ambient BEADS_DOLT_SERVER_PORT env var (#5835) 2026-08-20 05:43:57 -07:00
issueops fix: canonicalActor collapses the --/__ axes correctly; claim-verify uses ActorMatches (be-p7dzx, bundled be-vc51) (#5856) 2026-08-19 13:23:35 -07:00
journalops feat(journalops): the mutation journal becomes the third facade namespace (#5552) 2026-08-10 10:58:05 -07:00
memoryops Move the namespace-neutral error vocabulary into its own leaf (#5395) 2026-08-07 04:32:06 -07:00
npm-package chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -07:00
plugins/beads chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -07:00
release-gates fix(dolt): explicit ServerPort must outrank ambient BEADS_DOLT_SERVER_PORT env var (#5835) 2026-08-20 05:43:57 -07:00
schema feat: add public schema package re-exporting the migration API 2026-07-21 10:53:56 -07:00
scripts Fix: check-testing-short.sh flags comments and misnames the offending function (round 2) (#5809) 2026-08-19 21:01:15 -07:00
test feat(search): include closed issues by default (bd-t5yex) (#5392) 2026-08-07 00:35:50 -07:00
tests fix(ui): stop using blocked ● for priority in CLI output (#5511) 2026-08-10 06:19:51 -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 feat(issueops): name the two dependency-endpoint refusals (bd-yby99.9) 2026-08-07 19:45:54 +00:00
beads_cgo.go feat(storage): add extension-safe backend registry seam (#4859) 2026-07-31 03:05:48 -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 feat(storage): add extension-safe backend registry seam (#4859) 2026-07-31 03:05:48 -07:00
beads_test.go feat(storage): refuse test DBs on production dolt servers (AD-01) (#3632) 2026-07-24 01:28:51 -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 fix(dolt): explicit ServerPort must outrank ambient BEADS_DOLT_SERVER_PORT env var (#5835) 2026-08-20 05:43:57 -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 chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -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 chore(release): forward-port v1.2.2 to main (version record, retracts, recovery guide, gate record) (#5782) 2026-08-14 21:45:02 -07:00
go.sum chore(deps): bump the go-deps group across 1 directory with 11 updates (#5396) 2026-08-07 09:36:07 -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 fix(make): quote install paths containing spaces (#5600) 2026-08-10 23:03:42 -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 feat(storage): add extension-safe backend registry seam (#4859) 2026-07-31 03:05:48 -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 docs(release): make the CLI docs pin bump an explicit release step (wy-gx5rj) 2026-07-25 16:35:05 -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