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
obsidian ed71a9abc6 fix: remove unused source return value from getGitLabConfigValue (unparam)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Executed-By: beads/polecats/obsidian
Rig: beads
Role: polecats
2026-02-02 18:16:21 -07:00
.agent/workflows fix: improve JSONL-only mode detection and error messages (GH #534) 2025-12-13 12:50:33 -08:00
.beads fix: eliminate dolt split-brain root cause (B1+B2) and fix CGO build 2026-01-31 20:29:34 -08:00
.beads-hooks Fix shebang env (#817) 2026-01-01 10:54:22 -08:00
.claude docs: update daemon CLI syntax from flags to subcommands 2026-01-14 21:47:15 -08:00
.claude-plugin chore: Bump version to 0.49.3 2026-01-31 20:35:55 -08:00
.devcontainer Fix devcontainer init check - look for DB file not directory 2025-11-05 17:31:30 -08:00
.github Revert Dolt lock cleanup workaround; fix embedded Dolt open via driver retries (#1389) 2026-01-30 22:25:33 -08:00
claude-plugin chore: Bump version to 0.49.3 2026-01-31 20:35:55 -08:00
cmd/bd fix: remove unused source return value from getGitLabConfigValue (unparam) 2026-02-02 18:16:21 -07:00
docs Revert Dolt lock cleanup workaround; fix embedded Dolt open via driver retries (#1389) 2026-01-30 22:25:33 -08:00
examples docs: update daemon CLI syntax from flags to subcommands 2026-01-14 21:47:15 -08:00
integrations chore: Bump version to 0.49.3 2026-01-31 20:35:55 -08:00
internal fix: resolve gosec G104 unhandled rows.Close() errors in dependencies.go 2026-02-02 17:16:14 -07:00
npm-package chore: Bump version to 0.49.3 2026-01-31 20:35:55 -08:00
scripts fix: eliminate dolt split-brain root cause (B1+B2) and fix CGO build 2026-01-31 20:29:34 -08:00
tests/integration refactor: Remove legacy MCP Agent Mail integration (bd-6gd) 2025-12-17 23:14:23 -08:00
website docs: add GitHub Copilot integration guide with cross-platform MCP paths (#1348) 2026-01-27 11:25:14 -08:00
winget Add Windows ARM64 build support (#834) 2026-01-01 19:46:02 -08:00
.gitattributes fix(autoimport): auto-correct deleted status to tombstone for JSONL compatibility (#1231) 2026-01-21 21:50:38 -08:00
.gitignore chore: add Gas Town workspace entries to .gitignore 2026-01-30 23:07:05 -08:00
.golangci.yml fix(lint): resolve CI lint failures for v0.47.0 release 2026-01-08 20:21:02 -08:00
.goreleaser.yml fix(ci): disable CGO for Windows build in goreleaser 2026-01-31 01:21:39 -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 chore: code health review - test fix and error comments (bd-9g1z, bd-ork0) 2025-12-22 21:30:57 -08:00
AGENT_INSTRUCTIONS.md docs: Add agent warning about interactive bd edit command 2026-01-13 20:58:07 -08:00
AGENTS.md fix(dolt): remove bd sync from AGENTS.md 2026-01-25 11:05:20 -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(storage): document SQLite-only API and make FindAllDatabases backend-aware 2026-01-26 20:15:44 -08:00
beads_test.go bd-6xd: Standardize on issues.jsonl as canonical filename 2025-11-26 22:02:59 -08:00
BENCHMARKS.md feat(cli): add 'bd thanks' command to thank contributors 2025-12-14 12:40:32 -08:00
build-docs.md docs: Add comprehensive documentation for version reporting changes 2025-12-13 10:04:01 +11:00
CHANGELOG.md chore: Bump version to 0.49.3 2026-01-31 20:35:55 -08:00
CONTRIBUTING.md feat(daemon): unify auto-sync config for simpler agent workflows (#904) 2026-01-06 12:52:19 -08:00
default.nix chore: Bump version to 0.49.3 2026-01-31 20:35:55 -08:00
FEDERATION-SETUP.md docs: add federation setup guide (bd-wkumz.7) 2026-01-20 23:13:31 -08:00
flake.lock feat: Add Nix flake for declarative builds 2025-10-15 13:45:05 +02:00
flake.nix fix(nix): bake shell completions into default package (#1229) 2026-01-21 19:11:21 -08:00
go.mod Revert Dolt lock cleanup workaround; fix embedded Dolt open via driver retries (#1389) 2026-01-30 22:25:33 -08:00
go.sum Revert Dolt lock cleanup workaround; fix embedded Dolt open via driver retries (#1389) 2026-01-30 22:25:33 -08:00
install.ps1 docs: don't auto-install Go in Windows installer; instruct user instead (fixes #292) (#302) 2025-11-12 14:15:46 -08:00
LICENSE Initial commit: Beads issue tracker with security fixes 2025-10-11 20:07:36 -07:00
Makefile fix: eliminate dolt split-brain root cause (B1+B2) and fix CGO build 2026-01-31 20:29:34 -08:00
README.md docs: add GitHub Copilot integration guide with cross-platform MCP paths (#1348) 2026-01-27 11:25:14 -08:00
RELEASING.md feat: update to use core tap for beads installation (#1261) 2026-01-24 17:11:21 -08:00
SECURITY.md Prepare for public launch: comprehensive examples, docs, and tooling 2025-10-12 11:25:29 -07:00
THIRD_PARTY_LICENSES Add THIRD_PARTY_LICENSES for Apache 2.0 Dolt dependencies 2026-01-16 12:19:57 -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

  • Git as Database: Issues stored as JSONL in .beads/. Versioned, branched, and merged like code.
  • 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.
  • Invisible Infrastructure: SQLite local cache for speed; background daemon for auto-sync.
  • Compaction: Semantic "memory decay" summarizes old closed tasks to save context window.

📖 Essential Commands

Command Action
bd ready List tasks with no open blockers.
bd create "Title" -p 0 Create a P0 task.
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