- Go 95.2%
- Python 1.6%
- Starlark 1.5%
- Shell 1.3%
- Rust 0.2%
STORAGE LAYER ONLY, per CONTRIBUTING_PR_GUIDELINES.md. issueops.ListRequest and issueops.ReadyRequest gain Brief; no CLI flag and no HTTP parameter sets it yet, so no front door's payload changes. The wiring stacks on top. WHAT IT DROPS is the free-form text: description, design, acceptance_criteria, notes, payload and waiters are not selected, and the row comes back carrying types.Issue.IsLitePartial. #5546 measured a 16,051-issue store where `bd ready --json` returned 454,021 bytes and notes plus description were 76% of it, on the call an agent makes to decide what to work on. Measured through issueops.Reader on 100 rows sized from those per-row ratios: 362,301 bytes full, 24,001 brief, a 93.4% reduction. THE PRIMITIVE WAS HALF-BUILT AND UNREACHABLE. #3906 landed types.IssueFilter.Lite, IssueSelectColumnsLite, HeavyDropList, ScanIssueLiteFrom and Issue.IsLitePartial, then wired filter.Lite into exactly one place: SearchIssuesInTx, the UNCOUNTED store-backed search. Every read that answers with IssueWithCounts, which is every --json route of both commands, both implementations of issueops.Reader, and both HTTP reads, runs the counts mega-query instead and ignored the field. A request that set it would have come back correct, fully hydrated, and with nothing on it to say the projection had not happened. That silent no-op is what this closes. THE APPLICATION POINT IS THE COUNTS MEGA-QUERY, and it is one point rather than four because sqlbuild.SearchCountsSQL and issueops.ScanReadyWorkRowWithCounts are already the pair every counted read passes through: the store seam's list (search_counts.go) and ready (ready_work_counts.go), and the unit-of-work seam's list (issue_search_counts.go) and ready (ready_work_union.go, via fetchCountsByIDs). sqlbuild.CountsHydration is already the value that carries hydration opt-outs across that pair on both seams, so Lite is a third field on it rather than a new channel. IT CHANGES THE PROJECTION'S SHAPE, which SkipLabels and SkipCounts do not, and that is why ScanReadyWorkRowWithCounts now takes the whole hydration instead of a bool: the value that chose the SELECT list is the value that drives the scan, so the two cannot be given different answers. Substituting empty strings in the heavy positions would have kept one scan path and was rejected, because the row would carry blank text with IsLitePartial=false, which is indistinguishable from a genuinely textless row, the ambiguity ga-clgh and CommentsOmitted already record. WHERE IS INDEPENDENT OF SELECT, so this bounds the size of a row and never which rows match: DescContains, NotesContains and EmptyDesc keep selecting exactly what they select today, and no sort key, keyset cursor or wisp-merge dedup reads a dropped column (CompareIssuesBy orders on nine fields, none of them heavy). THE CLAIM REFUSES IT, which is not the same call the page makes and is the sharper case of the rule Limit and Offset already state. A claim does not read its row through the page's query at all: ExecuteClaimNext refetches the winning row whole with GetIssueInTx and hydrates its counts itself, so the projection has nothing to apply to. Accepting the field would answer a MUTATING request with a fully hydrated row carrying IsLitePartial=false, the caller's one signal that it did not get what it asked for, reporting that it did. The check lives in issueops.ValidateClaimNextRequest, which is the shared rule both ready claimers and BatchCloser's claim already run, so all four backends refuse it on the same line. BuildReadyCountFilter CARRIES it, which is the opposite treatment and the opposite reason. A count reads no field of any row, so the projection cannot make the number wrong, and the count is not always cheap enough for that to be the end of it: the unit-of-work seam has no COUNT(*) over the ready predicate and sizes the set by running the unbounded page and taking its length (uow/ready_counter.go), so dropping the field there would hydrate every heavy column of the whole ready set to answer `bd ready --brief`, a larger read than the page it was asked for. Carrying it also keeps that builder what its doc says it is: the listing's filter with the PAGE removed and nothing else. TWO ASYMMETRIES on the page path, both deliberate and both stated in code: - Brief IS carried onto the --ready arm (ReadyFilterFromIssueFilter) where SkipLabels and SkipCounts are dropped. Those two hide a number the ready renderings print; this drops a body no listing prints, so carrying it is what makes `bd list --ready` and `bd ready` answer one request one way. - types.WorkFilter carries Lite and neither of the other two, so the ready paths get readyHydrationFor rather than hydrationFor. Before this, both uow ready call sites passed a hardcoded CountsHydration{}, a literal that could not carry a filter's answer at all, which is how that path would have been missed. CONFORMANCE at all four registered sites, one Test per case, for the two page cases and for the claim refusal. Every field the cases assert stripped is seeded heavy first and the premise is checked, so a backend that never round-trips one of the six fails loudly instead of turning that clause into one that cannot fail. Identity is asserted too (ID, Title, Status, IssueType, Priority), or a body that stripped the row to its id would satisfy every emptiness clause. IsLitePartial is asserted in both directions. THE LITE COLUMN LIST IS PINNED BY ORDER, not only by membership. Both lists are scanned positionally, so two columns of the same SQL type can be transposed with no membership change at all: the pre-existing set-based parity test stays green, the scan succeeds, and every row silently carries one column's value in another's field. TestIssueSelectColumnsLite_IsFullMinusHeavyInOrder derives the expected list by deleting HeavyDropList from IssueSelectColumns in place, which makes the lite list a derivation rather than a second hand-maintained copy. RED BEFORE GREEN, five sabotages, each verified and reverted: - deleting the lite branch from CountsHydration.IssueColumns fails both page cases with "expected 58 destination arguments in Scan, not 52"; - accepting Brief without plumbing it to either filter, the silent no-op this change exists to close, fails both page cases on all six text fields and on IsLitePartial, which is the run that proves the assertions are load-bearing; - transposing created_by and owner in IssueSelectColumnsLite fails only the new order test, on IssueSelectColumnsLite[9] = owner, want created_by, while the set-based test stays green, which is the gap it was added for; - dropping the claim's refusal fails the claimer contract with "ClaimNext with brief: error = <nil>, want ErrValidation"; and - clearing Brief in BuildReadyCountFilter fails TestBuildReadyCountFilterIsTheUnboundedReadyFilter, which already existed to catch a ReadyRequest field the count builder forgets to carry and gains Brief in its fixture here. The recorded ready-filter golden gains "Lite": false in 62 cases because types.WorkFilter gained the field and the test compares marshaled JSON byte-for-byte. False is what a request that did not ask for the projection resolves that field to, so the replay stays exact; the test comment says so. Gates: go build ./..., go vet ./..., gofmt, internal/storage/... (dolt, embeddeddolt with BEADS_TEST_EMBEDDED_DOLT=1, uow, issueops, sqlbuild, domain/db), internal/workapi/..., backend/conformance/..., issueops/..., make api-check. Refs: #5546, #3906 Co-authored-by: sjarmak <t@t.co> |
||
|---|---|---|
| .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