- Go 95.2%
- Python 1.6%
- Starlark 1.5%
- Shell 1.3%
- Rust 0.2%
* fix(labels): normalize labels on write, as read paths already do (#5812) bd applies utils.NormalizeLabels (trim, drop empty, dedupe) to every label FILTER path -- list, search, ready, orphans, count and the workapi equivalents -- but to no label WRITE path. That asymmetry stores labels no filter can match: bd create "T" --labels 'theme:a, theme:b' # stores "theme:a", " theme:b" bd list --label theme:b # filter trims -- no match --labels 'a, b' is the comma-space form most people type, and pflag's CSV split leaves the leading space on the second element, so the split looks like it worked. A filtered list that is silently short is indistinguishable from a complete one. Two more everyday inputs corrupt just as quietly: --labels 'a,,b' stores an empty label, and --labels 'a,a' stores the same label twice. Apply the existing helper on the write paths so write and read agree: create (--labels and its --label alias, normalized after merging the two so dedupe spans both), quick, and update (--add-label, --remove-label, --set-labels). --remove-label matters as much as the additive flags: an untrimmed ' theme:a' fails to match the stored label and silently removes nothing. The --set-labels '' clear-all signal is preserved -- it is gated on pointer identity, not slice length. Also add a warn-only 'Label Whitespace' doctor check, since the write-path fix does nothing for labels already stored and nothing else surfaces them. It reports leading/trailing and blank labels only. A label whose trimmed form still contains whitespace is deliberately not reported: that turns on what a space between labels should mean, which this change does not settle, and "good first issue" is a legitimate multi-word label. Not auto-fixable by design -- trimming a damaged label can collide with a correct label already on the same issue, which needs a human decision. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * feat(labels): warn when a stored label contains a space (#5812) A label containing a space is almost always a comma that was meant and missed. That is the failure behind #5812's evidence: 150 corrupt label rows across 111 issues, found months later only because theme-by-theme counts failed to reconcile. The issue proposed splitting labels on whitespace as well as commas. This deliberately does NOT do that, and the reasoning is worth recording. A shell has exactly one mechanism for "is this one word or two", and it is already unambiguous. All three of these send ONE argument: bd create T --labels 'one two' bd create T --labels "one two" bd create T --labels one\ two They are byte-identical by the time bd sees them: quoting and backslash- escaping are consumed by the shell, which reports only the resulting word boundaries. It is the same mechanism that makes 'cd my\ dir' work. Splitting on whitespace would therefore override a boundary the caller has already explicitly set, making labels the one place on the command line where quoting does not mean what it means everywhere else. It is also undoable: with splitting there is no way left to ask for a label containing a space except a second, nested layer of quotes. And it cannot deliver what it appears to promise, since 'one two' and "one two" are indistinguishable by the time any code could act on them. So honor the shell's boundaries, which bd already does, and warn instead: ⚠ Stored "theme:a theme:b" as ONE label — it contains a space. If you meant several labels, separate them with commas (a,b) or repeat the flag. The 150 rows would have produced 150 warnings at the keystroke, while --labels 'good first issue' still does exactly what it says. A warning rather than an error, because a space-containing label is a legitimate thing to ask for and the shell has just been used to ask for it; --quiet silences it. No command changes meaning. Applied to the paths that write labels: create, q, --add-label and --set-labels. Deliberately not --remove-label, because removing a space-containing label is how the damage gets repaired and warning on the repair is noise. The Label Whitespace doctor check gains a matching third class so an existing database can find the ones already in it. It is reported separately from the untrimmed/blank classes and is not called corruption: bd cannot tell "good first issue" from a missed comma, so it surfaces them and a human decides. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(labels): close the last raw label write, bd tag (#5812) Review feedback on #5813. `bd tag` describes itself as "Shorthand for 'bd update <id> --add-label <label>'" and was not: update normalizes and warns, tag passed the positional straight to AddLabel, and the proxied route passed it to ApplyLabelPatch, which drops "" but does not trim. Verified on a scratch DB against binaries built either side of this commit: before: bd tag t-fap ' theme:spaced' -> stored " theme:spaced" bd list --label theme:spaced -> 0 rows after: bd tag t-wjz ' theme:spaced' -> stored "theme:spaced" bd list --label theme:spaced -> 1 row That is the unfilterable class this PR set out to close, written by the command whose help text promises equivalence with the one that already closed it. Normalization happens in tag.go BEFORE the route split, so the direct and proxied paths cannot diverge on it; runTagProxiedServer now takes the resolved id and label rather than raw args, which removes the second entry point. A whitespace-only label is refused (exit 1) rather than dropped. The plural flags can discard an empty element and still honor the rest of the request; bd tag has exactly one label to add, so dropping it would report success having written nothing. Also here, both from the same review: - `bd label add` now warns too. splitLabelArg already trimmed, so it never stored the untrimmed class, but it could not tell a caller that `bd label add bd-1 'theme:a theme:b'` is ONE label. Verified firing. - docs/core-concepts/labels.md: says plainly that import and batch ingest are deliberately NOT normalized (round-trip fidelity; the doctor check is what finds legacy damage), so the next reader does not "fix" it. Also notes that bare `bd doctor` is not yet supported in embedded mode (GH#3794), so the new Label Whitespace check reaches classic and server-mode databases only -- "run bd doctor" was overselling to embedded users. - CHANGELOG entries under Fixed and Added. Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com> Co-authored-by: Steve Yegge <steve.yegge@gmail.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 | ||
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