- Go 95.2%
- Python 1.6%
- Starlark 1.5%
- Shell 1.3%
- Rust 0.2%
* refactor(doltserver): share dolt's startup-output watcher with the plain server launcher Move the ready-line / port-in-use watcher that the proxied DoltServer uses (startupWatch, doltReadyLine, doltPortInUseTexts, logLevelEmitsReadyLine, ErrPortInUse) into internal/doltserver as StartupWatch and friends, so the plain server-mode Start can read the same signals. dbproxy/server already imports internal/doltserver, so it now uses them from there; its ErrPortInUse is the same error value. No behavior change. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(doltserver): prove the auto-started dolt owns its port; move a taken ephemeral port The plain server-mode Start (bd init --server, auto-start, bd dolt start) had the same blind readiness check the managed-local proxied backend had before #7184, plus a blind exit check: - It picked an ephemeral port, closed the probe listener and launched dolt, then slept 200ms and asked whether the child was still alive. dolt only reaches its port check after its own startup, which under load takes longer than that, so a lost port was never caught there. Worse, the child had been Release()d unreaped, and a zombie still answers kill(pid, 0), so an exit was invisible for the rest of the bd process. - It then waited for any MySQL greeting on the port. If another process took the port in between, either it was mute (a plain listener) and Start ran out its ready timeout -- the direct-local-server auto-start timeout seen under port churn -- or it was another dolt, and Start reported success against a server it did not start. Now each attempt launches the child with a goroutine that waits on (and reaps) it, and awaitOwnedListener accepts a greeting only once the listener is shown to be the child's: dolt's ready line in the child's output when its log level emits it (debug), or else the listening socket belonging to the child's process tree (Linux, via /proc/net/tcp and /proc/<pid>/fd). The child's output is read from the server log past the offset it started at, through the StartupWatch shared with dbproxy, so "Port N already in use." (printed at log_level warning too) ends the attempt at once as ErrPortInUse, and a child exit ends it as a failure. Port policy follows #7184's contract: only a port bd chose itself moves. An ephemeral port that is lost is retried on a fresh one (up to the existing 10 attempts); an explicitly configured port (env, config.yaml, metadata, dolt config) stays pinned and fails with ErrPortInUse and a remedy. Nothing operator-owned is rewritten: the generated dolt-server-config.yaml is bd's own state file and was already rendered per attempt. Where ownership cannot be proven (non-Linux, quiet log level) the greeting decides as before, but the child's exit and port-in-use report still end the wait. Tests: a fake dolt (this test binary, behind a PATH shim) that spends 700ms starting up and then binds like dolt does. A foreign greeter on the port is not accepted (ErrPortInUse); the child's own listener is; a child exit is reported promptly; and the real Start, handed a taken first ephemeral port, comes up on a fresh one (fails before this change: Start adopted the foreign port). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * test(doltserver): isolate user config in the DefaultConfig tests Four DefaultConfig tests failed under -tags integration on a host whose user config sets dolt.shared-server: true. The integration TestMain, unlike the plain one, does not redirect HOME, so: - TestDefaultConfigPrecedenceChain and TestDefaultConfigPortSource call config.Initialize, which merged ~/.beads/config.yaml. - TestDefaultConfigReturnsZeroForStandalone and TestDefaultConfigPortFileTakesPrecedence read whatever config an earlier test had loaded from the real HOME. Shared mode then sent DefaultConfig to the shared server's state dir and its port file ("port=3308 source=port_file, want 5002/config_yaml"). isolateUserConfig points HOME, USERPROFILE and XDG_CONFIG_HOME at an empty dir, the way TestDefaultConfig_NonzeroPortAlwaysHasSource already does. It also resets the loaded config before the test and again after it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * fix(doltserver): auto-start review fixes: record the server at launch, sharper ownership, port policy by source Follow-up to 0acb1041b, addressing review. B1: write the PID and port files again right after each launch, as before that commit, and remove them on every failure path (port conflict, not-ready, remotesapi). Previously a bd interrupted during the readiness wait left a dolt holding the database lock that nothing could find. The next start, bd dolt stop and killall all saw nothing. Both files carry the real port, so IsRunning never stops a starting server as "port unknown". S1: a child gone from /proc is known not to own the port; it is no longer "unknown", which would let a foreign greeting through. The child's log is re-read on every check, not only after its exit has been observed, because the reaper goroutine can lag the death. S2: if no listener on the port is listed although one just answered, /proc is incomplete (WSL1, some sandboxes, forwarding). That is now "unknown" (fallback to the greeting), not "foreign". Also "unknown": a /proc that is not this PID namespace's. S3: - bd's port-file port moves like an ephemeral one outside shared-server mode, since bd chose it (GH#4052). - Operator-configured ports and the shared-server port stay pinned. - The pinned error now says where the port came from (env, config.yaml, dolt config, metadata, --server-port, shared default, shared port file) instead of always "configured explicitly". S4: a killed child is waited for (up to 5s) before the next attempt or the return, so it has released the database lock. Its process group is killed too (unix), which reaches a dolt behind a non-exec wrapper. S5: when /proc proves the listener belongs to another process, the wait returns ErrPortInUse at once. It no longer sits out a slow child, which could outlast the timeout and turn a movable port into a hard failure. NITs: - Debug-mode timeout names the missing ready line and the way out. - The log tail restarts if the log is truncated under it. - waitForReady is removed; its probe tests now drive awaitOwnedListener. - Stale daemonization comment fixed in cmd/bd. - CONFIG_PROC_CHILDREN caveat documented. Tests: - fake-/proc ownership cases: owned, foreign, child gone, no listener row, unreadable fd table; - /proc/net/tcp parsing; - proven-foreign ends the wait at once; - port-in-use in the log counts before the exit is seen; - ready-line proof, with and without the line; - Start records PID+port while waiting; - Start removes them after a failed start; - pinned env port: one launch, ErrPortInUse, source in the message; - port-file port moves; - remedy wording per source. The Start tests now isolate the user config instead of skipping. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * test(doltserver): de-flake two startup tests under load - TestStart_RecoversWhenEphemeralPortIsTaken: on Linux, /proc proves the taken port foreign as soon as the greeting arrives, so the first child can be killed before the fake records its launch. Assert two port allocations and the final launch instead of the first launch. - TestAwaitOwnedListener_ReadyLine: give the "no ready line" case 8s, so the fake has time to start and greet on a loaded host. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 (1M context) <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 | ||
| third_party/patches | ||
| tools | ||
| winget | ||
| .bazelignore | ||
| .bazelrc | ||
| .bazelversion | ||
| .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 | ||
| BUILD.bazel | ||
| CHANGELOG.md | ||
| checks.nix | ||
| 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 | ||
| MODULE.bazel | ||
| MODULE.bazel.lock | ||
| 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 durable project facts; keep per-operator preferences in your harness's own memory.
- 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