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
Steve Yegge 371df32b51
Merge pull request #2188 from aaronlippold/fix/guard-create-database-shadow-db
Reviewed by refinery: Well-executed fix for shadow database creation. CreateIfMissing guard with comprehensive test coverage. All CI green.
2026-02-28 11:03:16 -08:00
.agent/workflows docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
.beads bd: backup 2026-02-28 18:53 2026-02-28 10:53:07 -08:00
.claude feat: add PreToolUse hook to block interactive cp/mv/rm prompts (bd-tm2p) 2026-02-27 16:16:24 -08:00
.claude-plugin fix(release): remove verify-cgo hook from CGO_ENABLED=0 builds 2026-02-22 19:34:50 -08:00
.devcontainer chore(deps): update mcr.microsoft.com/devcontainers/go docker tag to v2 (#1990) 2026-02-22 15:23:54 -08:00
.github chore(deps): update actions/cache action to v5 2026-02-23 10:01:43 -08:00
claude-plugin merge: sync docs/claim-start-work-followup with upstream main 2026-02-25 10:04:00 +03:00
cmd/bd Merge pull request #2188 from aaronlippold/fix/guard-create-database-shadow-db 2026-02-28 11:03:16 -08:00
docs Merge pull request #2188 from aaronlippold/fix/guard-create-database-shadow-db 2026-02-28 11:03:16 -08:00
examples feat(init): add --database flag to configure existing server database (#2102) 2026-02-24 22:26:07 -08:00
integrations feat(mcp): add dedicated claim tool for atomic start-work (#2071) 2026-02-24 22:10:01 -08:00
internal fix: replace SHOW DATABASES LIKE with exact-match iteration 2026-02-28 13:40:35 -05:00
npm-package docs(claim): standardize start-work semantics to --claim (#2070) 2026-02-24 22:11:39 -08:00
scripts fix: harden SQLite→Dolt migration safety, old-schema compat, and doctor recovery (#2156) 2026-02-26 15:48:47 -08:00
tests style: fix gofmt formatting in discovery_test.go 2026-02-25 16:06:31 -08:00
website docs: drop llms.txt formatting-only change 2026-02-25 10:16:43 +03:00
winget Add Windows ARM64 build support (#834) 2026-01-01 19:46:02 -08: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 fix: add .dolt/ to project .gitignore (#2081) 2026-02-24 22:24:50 -08:00
.golangci.yml fix(ci): resolve remaining CI test and lint failures 2026-02-17 22:55:54 +00:00
.goreleaser.yml fix(release): remove verify-cgo hook from CGO_ENABLED=0 builds 2026-02-22 19:34:50 -08:00
.pre-commit-config.yaml refactor: remove unused bd pin/unpin/hook commands (bd-x0zl) 2025-12-27 16:02:15 -08:00
.test-skip fix: rewrite TestRepairMultiplePrefixes for Dolt rename semantics (bd-alk64) 2026-02-14 11:05:39 -08:00
AGENT_INSTRUCTIONS.md docs: use make install instead of go build for bd binary 2026-02-25 09:11:08 +00:00
AGENTS.md fix: harden SQLite→Dolt migration safety, old-schema compat, and doctor recovery (#2156) 2026-02-26 15:48:47 -08:00
ARTICLES.md doc: create an ARTICLES.md for Articles & Tutorials about Beads (#1306) 2026-01-24 17:10:54 -08:00
beads.go fix: guard CREATE DATABASE to prevent shadow databases on wrong server 2026-02-28 13:29:51 -05:00
beads_test.go fix: prevent test suite from leaking databases onto production Dolt server (#2089) 2026-02-24 22:26:30 -08: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 fix: guard CREATE DATABASE to prevent shadow databases on wrong server 2026-02-28 13:29:51 -05:00
CLAUDE.md chore: Bump version to 0.55.2 2026-02-20 09:00:55 -08:00
codecov.yml ci: add Codecov integration with component-based coverage tracking 2026-02-18 20:00:01 -08:00
CONTRIBUTING.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
default.nix Update nix so beads builds (with latest go) 2026-02-26 06:49:34 -05:00
FEDERATION-SETUP.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
flake.lock Update nix so beads builds (with latest go) 2026-02-26 06:49:34 -05:00
flake.nix feat: add 'beads' alias for bd command during installation 2026-02-04 15:19:00 +00:00
go.mod fix(deps): update opentelemetry-go monorepo to v1.40.0 2026-02-24 17:04:10 +00:00
go.sum fix(deps): update opentelemetry-go monorepo to v1.40.0 2026-02-24 17:04:10 +00:00
install.ps1 fix: qualify Expand-Archive to avoid Pscx module conflict on Windows (#1826) 2026-02-17 21:16:05 -08:00
LICENSE Initial commit: Beads issue tracker with security fixes 2025-10-11 20:07:36 -07:00
Makefile fix: Makefile build and install fail on Windows when Make uses cmd.exe 2026-02-27 11:47:54 -07:00
NEWSLETTER.md docs: v0.56.1 release newsletter 2026-02-22 19:56:03 -08:00
README.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
RELEASING.md docs: remove stale daemon references from all documentation (GH#1982) 2026-02-22 17:57:53 -08:00
renovate.json Add renovate.json 2026-02-19 04:00:32 +00:00
SECURITY.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08: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, git-backed graph issue tracker for AI agents.

Platforms: macOS, Linux, Windows, FreeBSD

License Go Report Card Release npm version PyPI

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.

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

  • npm: npm install -g @beads/bd
  • Homebrew: brew install beads
  • Go: go install github.com/steveyegge/beads/cmd/bd@latest

Requirements: Linux, FreeBSD, macOS, or Windows.

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

📝 Documentation