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
matt wilkie f7061f9782
fix(docs): remove stale --branch flag and SQLite refs from QUICKSTART (GH#2522) (#2525)
- Remove bd init --branch beads-sync (flag no longer exists)
- Replace stale ~/.beads/default.db with correct .beads/dolt/ location
- Add outdated-content disclaimer to Community Articles in ARTICLES.md


Amp-Thread-ID: https://ampcode.com/threads/T-019cde55-544a-701a-a0e2-c06dee329d6a

Co-authored-by: Amp <amp@example.com>
Co-authored-by: Amp <amp@ampcode.com>
2026-03-11 12:54:30 -07:00
.agent/workflows docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -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 chore: bump version to 0.59.0 2026-03-05 16:00:25 -08:00
.devcontainer chore(deps): update mcr.microsoft.com/devcontainers/go docker tag to v2 (#1990) 2026-02-22 15:23:54 -08:00
.githooks fix: detect Go version mismatch in pre-commit hook before golangci-lint panics (bd-66nc) 2026-03-02 18:50:29 -08:00
.github fix(release): use brews instead of homebrew_casks for formula publishing 2026-02-28 23:50:20 -08:00
claude-plugin refactor: remove --allow-stale no-op flag and stale docs (w-bd-002) 2026-03-08 14:57:31 -07:00
cmd/bd fix: prevent bd init from creating DB on another project's Dolt server (GH#2336) 2026-03-10 19:45:45 -07:00
docs fix(docs): remove stale --branch flag and SQLite refs from QUICKSTART (GH#2522) (#2525) 2026-03-11 12:54:30 -07:00
examples docs: remove stale daemon refs and bd sync --status/--merge references 2026-02-28 19:54:49 -07:00
integrations cleanup: remove remaining daemon references missed by GH#2431 2026-03-10 15:34:20 -07:00
internal fix(docs): remove stale --branch flag and SQLite refs from QUICKSTART (GH#2522) (#2525) 2026-03-11 12:54:30 -07:00
npm-package chore: bump version to 0.59.0 2026-03-05 16:00:25 -08:00
scripts fix: skip sleep in CI/non-interactive environments 2026-03-06 14:42:03 -07:00
tests cleanup: remove daemon infrastructure remnants (GH#2431) 2026-03-10 15:24:27 -07:00
website docs: reconcile bd doctor --fix contradiction between architecture and recovery pages 2026-02-28 19:58:29 -07: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 cleanup: remove remaining daemon references missed by GH#2431 2026-03-10 15:34:20 -07:00
.golangci.yml fix(ci): resolve remaining CI test and lint failures 2026-02-17 22:55:54 +00:00
.goreleaser.yml fix(release): use brews instead of homebrew_casks for formula publishing 2026-02-28 23:50:20 -08:00
.pre-commit-config.yaml fix: detect Go version mismatch in pre-commit hook before golangci-lint panics (bd-66nc) 2026-03-02 18:50:29 -08:00
.test-skip fix: rewrite TestRepairMultiplePrefixes for Dolt rename semantics (bd-alk64) 2026-02-14 11:05:39 -08:00
AGENT_INSTRUCTIONS.md feat: add --stdin flag as alias for --body-file - on bd create/update (bd-gz2o) 2026-03-02 15:34:08 -08:00
AGENTS.md docs: teach agents to use stdin for descriptions (GH#1376) 2026-02-28 21:34:14 -07:00
ARTICLES.md fix(docs): remove stale --branch flag and SQLite refs from QUICKSTART (GH#2522) (#2525) 2026-03-11 12:54:30 -07: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 refactor(tests): migrate all test files from StartTestDoltServer to container-native API 2026-03-03 10:07:32 -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 chore: bump version to 0.59.0 2026-03-05 16:00:25 -08: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 chore: bump version to 0.59.0 2026-03-05 16:00:25 -08:00
FEDERATION-SETUP.md Remove stale sync mode documentation 2026-03-04 12:52:24 -05:00
flake.lock feat(nix): modernize flake for nixpkgs-25.11, fix-merge PR #2314 2026-03-03 17:24:10 -08:00
flake.nix feat(nix): modernize flake for nixpkgs-25.11, fix-merge PR #2314 2026-03-03 17:24:10 -08:00
go.mod chore(deps): migrate huh v0.8 to charm.land/huh/v2 (GH#2471) 2026-03-10 18:56:39 -07:00
go.sum chore(deps): migrate huh v0.8 to charm.land/huh/v2 (GH#2471) 2026-03-10 18:56:39 -07: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 feat: add gofmt + golangci-lint pre-commit hook (GH#2179) 2026-03-02 13:58:56 -08:00
NEWSLETTER.md docs: v0.56.1 release newsletter 2026-02-22 19:56:03 -08:00
packages.nix feat(nix): modernize flake for nixpkgs-25.11, fix-merge PR #2314 2026-03-03 17:24:10 -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: add network/privacy section to SECURITY.md 2026-03-04 11:21:29 +01: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