- Go 95.2%
- Python 1.6%
- Starlark 1.5%
- Shell 1.3%
- Rust 0.2%
* fix(hooks): export from linked worktree * fix(hooks): scope the worktree export retarget and share it with the importer Maintainer review fixups for #6717 (fixes #6680). Blocker — the pre-commit export retarget was unconditional. preCommitExportPath rewrote the destination whenever hookWorkTreeRoot() was non-empty, but that is true for *every* hook invocation (it returns filepath.Dir(GIT_DIR) for a plain repo too, pinned by export_auto_test.go's "plain repo" case). Any topology whose discovered beads dir is not <repoRoot>/.beads — a .beads/redirect to a shared out-of-repo store, a BEADS_DIR override, a beads dir above the repo root — silently stopped refreshing its real JSONL and instead got a brand-new in-repo dump that, being inside the worktree, passed gitAddFile's GH#3311 guard and was staged into the user's commit. worktreeJSONLDir now retargets only when the hook belongs to a *linked* worktree and the discovered beads dir lives inside the primary checkout — exactly the cross-worktree write #6680 reported. Everything else keeps the discovered directory and pre-#6680 behavior. The destination mirrors the beads dir's path *relative to the primary checkout*: a store renamed at the top level or nested under one (a relative .beads/redirect to tools/store) lands at the path the committing worktree actually tracks, rather than at a collapsed leaf no commit has ever contained. A lexical result that would escape the worktree, and a store that *is* the checkout root, both decline. Major — only the writer had moved. syncImportJSONLPath still imported <primary>/.beads/issues.jsonl while the hook wrote <worktree>/..., so a git pull in a linked worktree could import a JSONL the hook never updates. Both hook lanes now go through one resolver, hookJSONLDir. The non-hook auto-export lane (maybeAutoExport and its export-state.json key) is deliberately left alone and documented: it has no GIT_DIR to resolve a worktree from, and changing it means resolving the worktree from cwd for every bd command — a product decision, not a hook fix. Major — moving that reader made the importer's own subprocess harmful. `bd import` ran with BD_GIT_HOOK cleared, so its PersistentPostRun auto-export re-resolved the destination from beads.FindBeadsDir() and wrote <primary>/.beads/issues.jsonl. That was content-neutral while both halves of the sync path read the primary's copy; with the source moved to the worktree, a post-merge in a linked worktree writes one branch's issue state over another checkout's tracked file — #6680's second symptom, out of the fix for its first. No import path consults BD_GIT_HOOK (its only consumers are auto-export, auto-backup, the first-run metrics notice and terminal color), so the comment justifying the clear was false in exactly the way this commit already proved the export-side comment was. Both subprocesses now share hookSubprocessEnv. Also: - create the destination directory before exporting; atomicfile does not create parents, so a retargeted or nested export.path warned on every commit and wrote nothing. - run isExportFileStagedForDeletion from the nearest existing ancestor so a missing directory can no longer make exec fail and silently drop the GH#3838 `git rm` guard. - hookSubprocessEnv (was preCommitExportEnv) forces BD_GIT_HOOK=1 rather than being an identity copy that assumes the caller set it, and now serves both hook subprocesses. - record that keeping BD_GIT_HOOK also suppresses the subprocess auto-backup, and correct the comments that claimed the suppressed export could stage the primary's JSONL (gitAddFile's guard stops it) and that the redirect case was unreachable. - scope the hookLinkedWorktreePrimaryRoot comment to <root>/.git layouts. It is deliberately narrower than internal/beads' probe, which also serves bare-repo-backed worktrees: mirroring a tracked path needs a primary checkout and a bare repository has none, so #6680 stays unfixed for that layout and the comment now says so instead of claiming parity. - log the resolver's inputs and verdict, so a "keep beadsDir" outcome is observable under BD_DEBUG rather than indistinguishable from the hook not running at all. - document the sync lane's JSONL ownership decision, which this commit makes but did not state: the source file follows the committing worktree while the store it feeds stays the primary checkout's shared one, so a linked worktree on a feature branch can introduce that branch's rows there. Forward-only — the import never deletes and rewrites a row only when updated_at is strictly newer, a guard auto-import paths cannot switch off. - name, in worktreeJSONLDir, which lane actually reaches the mirrored non-.beads topologies. preCommitHasStagedBeadsFiles still gates the export lane on a hardcoded ".beads" pathspec (byte-identical to base), so a renamed or nested store normally stages nothing it matches and the mirror is reached by the sync lane; the comment is a correctness bound, not "nested stores now auto-export on every commit". - name the one case the gating does not catch: a <primary>/.beads that is itself a symlink out of the repository. pathInsideDir resolves symlinks on the parent only, so it still compares as inside the primary and gets retargeted. The supported .beads/redirect mechanism is unaffected; closing the hand-rolled `ln -s` case means resolving beadsDir before both the gating and the lexical Rel, which also moves the mixed-symlink-form case they currently decline. - keep this file's fixture helper out of the //go:build cgo namespace. writeFile lives in explicit_db_nodb_test.go, which the pure-Go (CGO_ENABLED=0) and native-Windows lanes exclude, so referencing it from this unconstrained file failed to compile the whole cmd/bd test binary there. Use a local writeFileForWorktreeTest, matching the suffixed naming the rest of this file already uses for the same collision reason. Tests: a gating matrix over the redirect / BEADS_DIR / already-inside / renamed / nested / checkout-root topologies; a real `git worktree add` fixture driving hookJSONLDir; and a wiring test that stands a stub `bd` on PATH and drives both call sites — asserting the pre-commit export writes and stages the worktree's JSONL while the primary's copy stays byte-identical, and that the post-merge import reads the worktree's copy with BD_GIT_HOOK=1. Reverting either call site to the discovered beads dir — the whole user-visible fix, which the earlier helper-only tests let pass — fails there. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Julian Knutsen <julianknutsen@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com> |
||
|---|---|---|
| .agent/workflows | ||
| .beads/formulas | ||
| .claude | ||
| .claude-plugin | ||
| .devcontainer | ||
| .githooks | ||
| .github | ||
| backend | ||
| beadserrors | ||
| cmd/bd | ||
| docs | ||
| engdocs | ||
| examples | ||
| format | ||
| integrations | ||
| internal | ||
| issueops | ||
| journalops | ||
| memoryops | ||
| npm-package | ||
| plugins/beads | ||
| release-gates | ||
| schema | ||
| scripts | ||
| test | ||
| tests | ||
| tools/docsmint | ||
| winget | ||
| .buildflags | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| .pre-commit-config.yaml | ||
| .test-skip | ||
| AGENT_INSTRUCTIONS.md | ||
| AGENTS.md | ||
| ARTICLES.md | ||
| beads.go | ||
| beads_cgo.go | ||
| beads_gated_test.go | ||
| beads_nocgo.go | ||
| beads_test.go | ||
| BENCHMARKS.md | ||
| build-docs.md | ||
| CHANGELOG.md | ||
| claim.go | ||
| claim_roundtrip_test.go | ||
| claim_test.go | ||
| CLAUDE.md | ||
| codecov.yml | ||
| CONTRIBUTING.md | ||
| CONTRIBUTING_PR_GUIDELINES.md | ||
| default.nix | ||
| errors_test.go | ||
| export_dependency_add_options_test.go | ||
| FEDERATION-SETUP.md | ||
| flake.lock | ||
| flake.nix | ||
| go.mod | ||
| go.sum | ||
| install.ps1 | ||
| issue_lifecycle_external_test.go | ||
| issue_roles_external_test.go | ||
| issues.jsonl | ||
| LICENSE | ||
| Makefile | ||
| mint.sh | ||
| NEWSLETTER.md | ||
| open_backend_selection_test.go | ||
| open_nocgo_test.go | ||
| overlay.nix | ||
| packages.nix | ||
| PR_MAINTAINER_GUIDELINES.md | ||
| PROPOSAL-cas-conditional-update.md | ||
| PROPOSAL-pluggable-storage-backends.md | ||
| PROPOSAL-pull-config-wedge.md | ||
| query_interfaces_cgo_test.go | ||
| query_interfaces_test.go | ||
| README.md | ||
| RELEASING.md | ||
| renovate.json | ||
| SECURITY.md | ||
| THIRD_PARTY_LICENSES | ||
| 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