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
Michael Percy d0f0ad6f22
fix(export): scrub git hook env and skip cross-worktree git-add (GH#3311) (#3347)
When export.git-add=true (the v1.0.1+ default), the pre-commit hook in
a worktree stages a spurious issues.jsonl at the repo root instead of
(or in addition to) .beads/issues.jsonl. The ghost file lands in the
commit's diff but not on disk — easy to miss and painful to clean up.

Root cause (not what the issue body guessed): the absolute path passed
to `git add` was always correct. The bug is env inheritance. Git
invokes the pre-commit hook with GIT_DIR/GIT_WORK_TREE/GIT_INDEX_FILE/
GIT_COMMON_DIR/GIT_PREFIX set in the environment, and bd's git-add
subprocesses inherit them.

Both call sites set `cmd.Dir = filepath.Dir(fullPath)` (= `.beads/`).
With GIT_DIR set in the environment and GIT_WORK_TREE unset, git
defaults the work-tree to cwd. So the subprocess's git sees `.beads/`
as the work-tree root and records `.beads/issues.jsonl` at the root of
that broken view — which ends up in the worktree's actual index as a
bare `issues.jsonl`. Verified empirically: with GIT_DIR set and
cwd=`.beads/`, `git rev-parse --show-toplevel` returns the `.beads/`
directory itself.

Fix, in two parts:

 1. scrubGitHookEnv() strips the vars that poison repo/worktree
    auto-discovery, index routing, object routing, and config
    injection:
      - discovery: GIT_DIR, GIT_WORK_TREE, GIT_COMMON_DIR, GIT_PREFIX,
        GIT_CEILING_DIRECTORIES, GIT_DISCOVERY_ACROSS_FILESYSTEM
      - index: GIT_INDEX_FILE
      - objects: GIT_OBJECT_DIRECTORY, GIT_ALTERNATE_OBJECT_DIRECTORIES
      - config: the whole GIT_CONFIG* family (covers the case where the
        parent invoked `git -c core.worktree=… commit`, which sets
        GIT_CONFIG_PARAMETERS / GIT_CONFIG_COUNT in the child env)
    With these cleared, git rediscovers the repo/worktree from cwd.

 2. hookWorkTreeRoot() reads the inherited GIT_DIR to determine the
    worktree whose hook is currently firing. If the target path is
    outside that worktree, gitAddFile returns without staging. This
    prevents a narrower but real regression that would otherwise land
    after part 1 alone: in the .beads/redirect configuration, fullPath
    points into the main repo (not the worktree), and post-scrub git
    would silently stage the file into main's index from a worktree
    hook. The existing preCommitHookBody template (init_git_hooks.go)
    documents the same intent: "For worktrees: .beads is in the main
    repo's working tree... we skip it."

The guard uses pathInsideDir which handles the macOS symlinked-parent
case: on /tmp → /private/tmp, a fresh-file target expressed as
/tmp/.../new.txt compared against a worktree root resolved to
/private/tmp/... would otherwise misclassify as outside the worktree.
pathInsideDir resolves the parent of each side via EvalSymlinks and
reattaches the basename — sufficient for the real caller shapes, since
gitAddFile's parent directory (beadsDir or the export output dir)
always exists at call time.

Also fixes the variant reported in a follow-up comment where the
.beads/redirect workaround did not resolve the root ghost: the env
pollution broke git-add inside the `bd export -o` subprocess spawned
from exportJSONLForCommit (that subprocess has BD_GIT_HOOK stripped,
but git env vars preserved, so its PostRun auto-export hits the same
bug via the shared gitAddFile).

Deduplicates the parallel git-add invocation in exportJSONLForCommit
by delegating to gitAddFile, so both call sites share the env scrub
and the cross-worktree guard.

Adds:
 - TestGitAddFile_InWorktreeHook_StagesCorrectPath — end-to-end
   worktree regression test; fails on main, passes with the fix.
 - TestGitAddFile_RedirectCase_DoesNotStageInMainRepo — verifies
   the cross-worktree skip does not pollute main's index when a
   worktree has .beads/redirect pointing into main.
 - TestGitAddFile_NonHookContext_GuardDoesNotFire — regression guard
   confirming the cross-worktree skip is a no-op outside git hooks.
 - TestScrubGitHookEnv — unit test for the env scrub helper, covering
   the discovery/index/object vars and the GIT_CONFIG* family, and
   verifying non-discovery vars (author/committer/editor/pager) pass
   through untouched.
 - TestPathInsideDir — covers structural cases plus the macOS
   fresh-file + symlinked-parent regression.
 - TestHookWorkTreeRoot — covers linked-worktree gitdir file,
   plain-repo .git, bare/unrecognized, and not-a-hook contexts.

Workaround for users on older releases remains `BD_EXPORT_GIT_ADD=false`.

Closes GH#3311

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-20 21:08:13 -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
.claude chore: switch crew policy from direct-push to PR-by-default 2026-04-15 13:48:02 -07:00
.claude-plugin release: beads v1.0.2 — npm provenance URL fix 2026-04-15 13:42:06 -07:00
.devcontainer chore(build): codify the gms_pure_go build-tag policy (GH#3303) 2026-04-16 12:28:11 -07:00
.githooks fix: use CGO_ENABLED=0 for pre-commit linter 2026-04-06 21:09:55 -07:00
.github ci: don't fail workflows when codecov upload has no token (#3386) 2026-04-20 18:31:56 -07:00
claude-plugin Keep regular epics open after the last child closes (#3276) 2026-04-17 15:10:38 -07:00
cmd/bd fix(export): scrub git hook env and skip cross-worktree git-add (GH#3311) (#3347) 2026-04-20 21:08:13 -07:00
docs add Thread to community tools - analytics and observability (#3329) 2026-04-20 18:20:30 -07:00
examples feat: add starter formula examples (#3248) 2026-04-20 18:05:03 -07:00
format feat: add public format package for issue rendering (#2871) 2026-04-02 19:33:53 -07:00
integrations chore(deps): bump pydantic in /integrations/beads-mcp (#3321) 2026-04-17 15:04:20 -07:00
internal fix(ci): unblock main — gosec G122 + credentials_test signatures (#3389) 2026-04-20 19:02:11 -07:00
npm-package release: beads v1.0.2 — npm provenance URL fix 2026-04-15 13:42:06 -07:00
scripts chore(build): codify the gms_pure_go build-tag policy (GH#3303) 2026-04-16 12:28:11 -07:00
tests fix(ci): drop ICU linkage from test jobs, use -tags gms_pure_go everywhere (#3240) 2026-04-14 10:01:46 -07:00
website docs: add missing workflow features to docs and regenerate llms-full.txt (#3250) 2026-04-20 18:16:30 -07:00
winget docs: replace "git-backed" with "Dolt-powered", add git-free usage guide 2026-03-13 11:44:50 -07:00
.buildflags chore(build): codify the gms_pure_go build-tag policy (GH#3303) 2026-04-16 12:28:11 -07:00
.gitattributes fix: remove JSONL gitignore rules, merge driver, and issues tracking check (bd-9ni.6) 2026-02-22 21:50:17 -08:00
.gitignore chore(gitignore): ignore .codex marker and .claude/*.lock 2026-04-16 14:57:18 -07:00
.golangci.yml fix(ci): resolve remaining CI test and lint failures 2026-02-17 22:55:54 +00:00
.goreleaser.yml fix: add gms_pure_go tag to linux-amd64 build to remove ICU runtime dep (#2991) 2026-04-05 17:21:16 -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 Rename ICU-only test path to explicit opt-in workflow (bd-b18) (#3291) 2026-04-16 08:54:24 -07:00
AGENTS.md Rename ICU-only test path to explicit opt-in workflow (bd-b18) (#3291) 2026-04-16 08:54:24 -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: export WispFilter type from root package (#2868) 2026-04-02 19:22:06 -07:00
beads_cgo.go feat: add OpenBestAvailable to public API (#3143) (#3149) 2026-04-09 11:21:13 -07:00
beads_nocgo.go feat: add OpenBestAvailable to public API (#3143) (#3149) 2026-04-09 11:21:13 -07:00
beads_test.go test: restore OpenBestAvailable tests from bgjackma's PR #3143 (#3150) 2026-04-09 12:41:06 -07:00
BENCHMARKS.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08: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: beads v1.0.2 — npm provenance URL fix 2026-04-15 13:42:06 -07:00
CLAUDE.md fix: remove nonexistent -i flag from bd import references (#3200) 2026-04-11 12:31:38 -07:00
codecov.yml ci: add Codecov integration with component-based coverage tracking 2026-02-18 20:00:01 -08:00
CONTRIBUTING.md ci: add nix build check to catch vendorHash drift (GH#3298) (#3364) 2026-04-20 13:21:53 -07:00
default.nix fix(nix): update vendorHash after dependabot go.sum bumps (GH#3221) (#3297) 2026-04-15 16:10:46 -07:00
FEDERATION-SETUP.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
flake.lock Update nix install for v1.0.0 (#3064) 2026-04-07 20:07:07 -07:00
flake.nix Update nix install for v1.0.0 (#3064) 2026-04-07 20:07:07 -07:00
go.mod chore(deps): bump charm.land/lipgloss/v2 from 2.0.2 to 2.0.3 (#3325) 2026-04-17 14:44:46 -07:00
go.sum chore(deps): bump charm.land/lipgloss/v2 from 2.0.2 to 2.0.3 (#3325) 2026-04-17 14:44:46 -07:00
install.ps1 [codex] Fix installer ICU/CGO fallback handling (#2965) 2026-04-01 16:52:53 -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 chore(build): codify the gms_pure_go build-tag policy (GH#3303) 2026-04-16 12:28:11 -07:00
NEWSLETTER.md chore: bump version to 0.62.0 2026-03-21 19:50:38 -07:00
open_nocgo_test.go test: restore OpenBestAvailable tests from bgjackma's PR #3143 (#3150) 2026-04-09 12:41:06 -07:00
packages.nix feat(nix): modernize flake for nixpkgs-25.11, fix-merge PR #2314 2026-03-03 17:24:10 -08:00
README.md feat(docs): version Docusaurus site and align llms-full with snapshots (#3033) 2026-04-06 21:12:54 -07:00
RELEASING.md Add release stability gate for upgrade safety (GH#2951) (#2963) 2026-04-01 17:00:25 -07:00
renovate.json Add renovate.json 2026-02-19 04:00:32 +00:00
SECURITY.md fix: surface auto-export and auto-backup errors to stderr (#3122) 2026-04-07 20:37:13 -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://gastownhall.github.io/beads/

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.

⚡ Quick Start

# Install beads CLI (system-wide - don't clone this repo into your project)
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash

# Initialize in YOUR project
cd your-project
bd init

# Tell your agent
echo "Use 'bd' for task tracking" >> 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.

🛠 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.

🔗 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/INSTALLING.md for complete installation guide.

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/ANTIVIRUS.md for Windows AV false-positive guidance and verification workflow.

💾 Storage Modes

Beads uses Dolt as its database. Two modes are available:

Embedded Mode (default)

bd init

Dolt runs in-process — no external server needed. Data lives in .beads/embeddeddolt/. Single-writer only (file locking enforced). This is the recommended mode for most users.

Server Mode

bd init --server

Connects to an external dolt sql-server. Data lives in .beads/dolt/. Supports multiple concurrent writers. Configure the connection with flags or environment variables:

Flag Env Var Default
--server-host BEADS_DOLT_SERVER_HOST 127.0.0.1
--server-port BEADS_DOLT_SERVER_PORT 3307
--server-user BEADS_DOLT_SERVER_USER root
BEADS_DOLT_PASSWORD (none)

Backup & Migration

Back up your database and migrate between modes using bd backup:

# Set up a backup destination and push
bd backup init /path/to/backup
bd backup sync

# Restore into a new project (any mode)
bd init           # or bd init --server
bd backup restore --force /path/to/backup

See docs/DOLT.md for full migration instructions.

🌐 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.

🚀 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

For daemon mode without git, use bd daemon start --local (see PR #433).

📝 Documentation