- Go 95.2%
- Python 1.6%
- Starlark 1.5%
- Shell 1.3%
- Rust 0.2%
* fix(bd): canonicalize actor==assignee comparisons in unclaim.go and AuthorizeAssigneeTransferWithPools Follow-up to ga-wzl83, which canonicalized the two pure-Go validators in internal/validation/issue.go but explicitly left out two higher-risk sites. UnclaimIssueInTx / UnclaimIssueIfAssigneeInTx compared actor/expectedAssignee to the stored assignee verbatim, both in a Go-side precheck AND in the SQL UPDATE's WHERE clause -- so canonicalizing only the Go side would not have fixed `bd unclaim` end-to-end. Replaced the `assignee = ?` SQL predicate with a `row_lock = ?` CAS against the RowVersion read moments earlier: every ownership/status/started_at mutation always rewrites row_lock (the documented freshRowLock invariant in lease.go), so this detects the exact same race the old predicate did -- and more (status/started_at races too) -- without embedding a spelling-sensitive string comparison in SQL. AuthorizeAssigneeTransferWithPools (the single fence both the DBTX and unit-of-work backends evaluate, per its own doc comment) compared before.Assignee to request.Actor and to request.Patch.Assignee.Value verbatim, so a caller naming the current holder under a different layer's identity spelling was wrongly fenced as a stranger. Both fixes reuse the canonicalActor/actorMatches shape from ga-wzl83, kept as a small package-local duplicate in issueops (internal/storage/issueops importing internal/validation would invert the layering). Verified: new cross-spelling cases in aggregate_authorize_transfer_test.go and new end-to-end cases in unclaim_embedded_test.go / unclaim_conditional_embedded_test.go (against a real embedded Dolt backend) all fail with the exact bug-report symptom against the pre-fix code and pass after the fix, with no regressions in the existing suites. ga-5ksp5 * fix(bd): close the sibling-CAS disagreement gate review flagged on #5439 Review verdict on #5439 was "MERGE AFTER ONE FIX": after this branch's unclaim.go/aggregate.go fix, bd unclaim --if-assignee succeeds under a respelled identity while bd update --expected-assignee on the same bead still fails ErrAssigneeMismatch — the same verbatim actor==assignee defect (ga-wzl83), left in two more places. - internal/storage/issueops/update_cas.go:46 (CheckExpectedFieldsInTx) now compares under actorMatches (package-local, unexported — same package as identity.go, no new import needed). - internal/storage/domain/issue.go:643 (ApplyUpdate, the unit-of-work twin) now compares under validation.ActorMatches. domain cannot import internal/storage/issueops (issueops already imports domain in several files — the reverse would cycle), but domain -> internal/validation is safe (validation depends only on internal/types), so this reuses the already-shipped validation copy instead of adding a third duplicate. Two non-blocking asks from the same review, addressed: - Exported internal/validation's canonicalActor/actorMatches to CanonicalActor/ActorMatches so domain/issue.go could reuse them (the reviewer's own point: "an issueops -> validation import creates no cycle... layering inversion is a style call, not a compile fact" applies equally to domain -> validation). Also fixed a garbled mid-sentence doc comment on ActorMatches while touching the file (separate nit from the same review, on #5438). - Added a cross-package parity test (internal/storage/issueops/identity_parity_test.go) that runs the existing CanonicalActor/ActorMatches case tables through both this package's local duplicate and validation's exported version, so the two copies can't silently drift. Mutation-tested: dropped the hyphen separator from issueops's copy, confirmed the two hyphen-related cases correctly fail, reverted. New conformance test (backend/conformance, wired into all three backend legs) proves the fix end-to-end: an ExpectedAssignee guard now accepts a different spelling of the current holder and still refuses a genuinely different identity. Added as a SEPARATE function rather than extending the existing RunIssueOperationsUpdateConditionalGuardsGateOrdinaryEdits — that test's later "order-dependent composition" arm depends on the row's assignee staying exactly "holder" through to the end, which a mid-test respelling would have broken. Verification: internal/validation, internal/storage/issueops, internal/storage/domain(+db,fs,git) all green. New conformance test passes on embeddeddolt and uow (dolt backend skips locally, no Docker — matches the existing documented limitation, CI covers it). Broader regression subset (Update/Claim/Unclaim, 28 embeddeddolt + 22 uow cases) green, no regressions. go build/vet/gofmt clean. Filed ga-4ymii for the reviewer's second (also non-blocking) ask: the remaining verbatim sites at issueops/claim.go (SQL CAS + idempotent re-claim), its domain/db and domain/issue.go uow twins, and issueops/lease.go's heartbeat holder check — out of scope for this PR per the reviewer's own framing ("please file the follow-up"). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * fix(bd): dispatch the respelled-assignee contract case onto the role seam TestRoleContractCasesCoverEveryContractCase (main, post-dating this branch's fork point) caught a real gap: the ga-5ksp5 contract case added to this branch's earlier commit (RunIssueOperationsUpdateConditionalGuardAccepts- RespelledAssignee) had no roleContractCases dispatch row, so an external backend running RunRoleContracts would never see it. The reason isn't a missed row so much as the whole RunIssueOperationsUpdate* family this case was written beside having been renamed and moved to RunLifecycleUpdate* in backend/conformance/lifecycle_update_contract.go by main's "de-stage the hard Lifecycle contracts onto the role seam" refactor, which landed on main after this branch forked. Ported the case to match: same logic, adapted to the new fixture's idioms (fixture.Lifecycle.Update instead of fixture.Operations.Update, lifecycleUpdateRow(...).Priority instead of a raw SQL assertion, storage.ErrAssigneeMismatch instead of publicops.ErrAssigneeMismatch, seedLifecycleUpdateIssue instead of seedClosePolicyIssue) — not a mechanical copy. Also wired it into the three per-backend TestLifecycleUpdateContract dispatch lists (dolt, embeddeddolt, uow) beside its ConditionalGuardsGateOrdinaryEdits sibling, so it actually runs against real backends rather than only satisfying the completeness guard. Verified: TestRoleContractCasesCoverEveryContractCase passes; the ported case passes against embeddeddolt (0.35s) and uow (0.17s) for real, not just compiles (dolt backend test skips in this sandbox — no Docker); full backend/conformance suite and repo build clean. --------- Co-authored-by: Claude Sonnet 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 | ||
| 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 | ||
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