- Go 95.2%
- Python 1.6%
- Starlark 1.5%
- Shell 1.3%
- Rust 0.2%
* fix(hooks): allowlist prime args and exec os.Executable() in runBdPrime
The agent lifecycle hooks re-execute the bd binary to run `bd prime`
without re-entrant store initialization. runBdPrime built that exec from
os.Args[0] plus a variadic argument list, which static analysis flags as
a command taint surface: nothing structurally prevents a future caller
from passing arbitrary strings into the subprocess.
Harden the seam explicitly:
- validatePrimeArgs refuses anything outside the closed set of hook
flags (only --memories-only is ever passed today) before the
subprocess is built, so a caller can never steer the re-exec.
- resolve the executable with os.Executable() instead of os.Args[0],
so the target binary comes from the kernel's view of this process
rather than from argv.
No behavior change for the two real callers (codex-hook, cursor-hook),
which pass only the allowlisted flag or nothing.
Addresses the Snyk Code static-analysis finding on cmd/bd/agent_hook.go
line 26 as hardening.
* test(hooks): stub the re-exec seam and name the rejected argument
Review follow-up to 3435a5755 (round 1, non-blocking). Two test
robustness fixes:
- primeExecutable becomes an injectable seam (var primeExecutable =
os.Executable). The reject test now overrides it and asserts the
resolver never runs for rejected args, so a future reorder that drops
validatePrimeArgs fails the test instead of live-exec'ing the test
binary into a self-exec chain. No test path can reach
exec.CommandContext anymore, and the resolver error path gains
coverage of its own.
- The rejection tests assert the offender ("--config") rather than the
generic substring, so loosening the allowlist for one flag can no
longer mask another.
Also refreshes the PR-facing wording: os.Executable() is a small,
deliberate behavior delta over os.Args[0] (running binary instead of
per-call PATH lookup), noted in the PR description.
* docs(hooks): keep the nosec invariant text true through the seam
Review round 2, nit 5: the #nosec comment still named os.Executable
directly, but the value now arrives one hop indirect through
primeExecutable. Reword the invariant ("exe comes from primeExecutable,
which is os.Executable in production") so the annotation stays accurate.
Comment-only.
* review: pin the prime re-exec target and harden its resolver
Maintainer review fixes for iteration 1 (adopt-pr #6414).
major (Test Evidence Quality): no test reached the exec construction, so
the change's central claim -- that the *resolved* executable is the exec
target -- was unpinned; a mutant that kept the primeExecutable() call and
exec'd os.Args[0] passed all four new tests. Split the construction out of
the I/O as primeCommand(ctx, args...) (*exec.Cmd, error) and assert
cmd.Path and the full cmd.Args against a stubbed resolver. The sentinel
contains a path separator on purpose: exec.Command only skips LookPath for
names that do, so a bare name would leave cmd.Path host-PATH-dependent.
Verified by mutation -- reverting the exec target to os.Args[0] reds only
the new pin and leaves the original four green.
minor (Architectural Consistency): primeExecutable took one of the three
hardening steps doctor/fix's getBdBinary pairs. Give the production
resolver that precedent's shape -- EvalSymlinks (tolerating failure), a
*.test / .test. base-name refusal so an unstubbed test call fails loudly
instead of fork-bombing, and a validated PATH fallback -- and pin the
refusal the way doctor/fix's own suites pin ErrTestBinary. The residual
resolution trade-off, which the PATH fallback does not cover, is now
stated at the declaration instead of left implicit.
nit (Contract & Interface Fidelity): the #nosec named G702, which is not
the subprocess rule. Name G204 and say plainly that .golangci.yml excludes
it repo-wide, so no reader mistakes the annotation for what keeps lint
green.
Iteration 2 -- prose only, no behaviour change:
minor (Debuggability & Operability): the trade-off paragraph added above
documented a mechanism that does not exist. It said os.Executable "pins
/proc/self/exe", so a bd replaced in place by an ordinary
`go install ./cmd/bd` resolves to a "(deleted)" path the PATH fallback
does not cover, and credited inode pinning for PATH-independence. On Linux
os.Executable ends TrimSuffix(path, " (deleted)")
(os/executable_procfs.go), so no "(deleted)" path ever reaches the
resolver. Measured both cases with a live probe against a running binary:
replaced in place, EvalSymlinks SUCCEEDS and the re-exec runs the
replacement, so the documented breakage does not occur; deleted without
being replaced, EvalSymlinks fails, the tolerated-failure branch keeps the
stale path, and the fallback correctly never runs because os.Executable
returned no error. Re-scope the paragraph to that second case, which is
the real residual gap, and credit PATH-independence to the path containing
a separator -- exec.Command calls LookPath only when
filepath.Base(name) == name.
nit (Test Evidence Quality) declined, recorded so it is not re-litigated:
deleting the EvalSymlinks block leaves the prime selector green, so that
arm is unpinned while the other two red exactly one test each. Pinning it
needs a second production seam var for os.Executable -- the resolver reads
the real one, and under `go test` the .test refusal fires before the
EvalSymlinks result is observable -- which is more machinery than a
best-effort step whose failure is tolerated by design warrants. getBdBinary
has the identical gap, so this is an unclosed class rather than a
regression from this change.
* ci(bazel): make the prime re-exec hardening green on the Bazel lane
This PR was opened against a base that had no Bazel lane. The lane landed in
the base advance since (`.github/workflows/bazel.yml`, generated BUILD files,
and #6871's test-binary work), and it reds this PR in two independent ways.
Both are fixed here; neither is reachable from the PR's original base.
1. `cmd/bd/BUILD.bazel` did not exist at the old base, so gazelle never saw
the new `cmd/bd/agent_hook_test.go` and it is absent from `go_test(bd_test)`
srcs. `make bazel-sync` adds exactly the one line committed here, which is
what bazel.yml's "BUILD files in sync" step checks with `git status`. Of the
24 `cmd/bd/*_test.go` files absent from that list, the other 23 are excluded
by a `//go:build` tag; `agent_hook_test.go` is the only untagged one, and a
whole-tree gazelle run produces no other drift.
2. With the test file declared, `TestResolvePrimeExecutableRefusesTestBinary`
then fails under Bazel: rules_go links the binary as `bd_test`, so the
`.test` name checks never fire and `resolvePrimeExecutable` hands back the
test binary instead of refusing it. This is not just a test artifact — it is
the fork-bomb the refusal exists to prevent, live on the new lane.
`getBdBinary` (cmd/bd/doctor/fix/common.go), the precedent this resolver
deliberately restates, hit the same problem and #6871 (`
|
||
|---|---|---|
| .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 | ||
| third_party/patches | ||
| tools | ||
| winget | ||
| .bazelignore | ||
| .bazelrc | ||
| .bazelversion | ||
| .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 | ||
| BUILD.bazel | ||
| CHANGELOG.md | ||
| checks.nix | ||
| 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 | ||
| MODULE.bazel | ||
| MODULE.bazel.lock | ||
| 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 | ||
| VERSIONED-BEADS-WRITE-PATHS.md | ||
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