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
Sam 7e4da9ab20
Add credentials file support for Dolt server passwords (#2854)
* feat: add credentials file support for Dolt server passwords

Add INI-style credentials file (~/.config/beads/credentials) as a
fallback for Dolt server passwords, keyed by [host:port] section.
This lets users working with multiple servers avoid juggling env vars
per project.

Lookup order: BEADS_DOLT_PASSWORD env var > credentials file > empty.
Path overridable via BEADS_CREDENTIALS_FILE env var.
Warns on overly permissive file permissions (unix only, mirrors ssh).

* docs: document credentials file in DOLT.md

Add credentials file section to the Dolt backend docs covering file
format, default location, permission warnings, and password resolution
order. Update the config reference and env var table to reference the
new feature.

* fix: use resolved runtime port for credentials file lookup

The credential file lookup in GetDoltServerPassword() used the port
from metadata.json, but the actual connection port comes from
doltserver.DefaultConfig() which has its own priority chain (port file >
config.yaml > metadata.json). When these diverge — e.g., IAP tunnel on
3308 vs local Dolt on 3307 — the credentials file lookup used the wrong
[host:port] section.

Add GetDoltServerPasswordForPort() that accepts an explicit port, and
use it in main.go where the resolved runtime port is already known.
Existing GetDoltServerPassword() delegates to the new method for
backward compatibility.

* fix: use mysql.Config.FormatDSN for proper password escaping

Passwords with special characters (& < > / % etc.) were inserted raw
into the DSN string, breaking go-sql-driver/mysql parsing. Passwords
like "zId&z,L9P4X,%k4n4rylGV<Ibos9<)/p" would cause "Access denied"
errors even though the password was correct.

Switch from manual fmt.Sprintf DSN construction to mysql.Config's
FormatDSN(), which handles escaping correctly. This also consolidates
timeout and TLS configuration into the typed Config struct instead of
string concatenation.

* test: add DSN special character password roundtrip tests

Covers passwords with &, <, >, /, ?, %, @, :, and () — all of which
broke the old fmt.Sprintf DSN construction. Verifies that FormatDSN
produces a parseable DSN and the password survives the roundtrip.
2026-04-02 20:35:56 -07:00
.agent/workflows docs: replace bd sync with bd dolt push/pull in agent instructions (GH#2563) 2026-03-13 11:01:06 -07:00
.claude fix: allow external contributors to create PRs via block-gh-watch hook 2026-03-29 14:04:32 -07:00
.claude-plugin fix(release): revert all non-Linux targets to CGO_ENABLED=0, bump v0.63.3 2026-03-30 08:58:25 -07: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: use go run for golangci-lint in pre-commit hook 2026-03-17 11:29:41 -04:00
.github fix: configure link checker root dir for docusaurus deploy 2026-04-02 20:30:05 -07:00
claude-plugin fix(release): revert all non-Linux targets to CGO_ENABLED=0, bump v0.63.3 2026-03-30 08:58:25 -07:00
cmd/bd Add credentials file support for Dolt server passwords (#2854) 2026-04-02 20:35:56 -07:00
docs Add credentials file support for Dolt server passwords (#2854) 2026-04-02 20:35:56 -07:00
examples fix(docs): purge stale bd sync/import/--branch refs + add CI doc validation (GH#2522) 2026-03-11 13:25:40 -07:00
format feat: add public format package for issue rendering (#2871) 2026-04-02 19:33:53 -07:00
integrations chore(deps): bump fastmcp from 3.1.1 to 3.2.0 in /integrations/beads-mcp (#2918) 2026-03-31 13:55:40 -07:00
internal Add credentials file support for Dolt server passwords (#2854) 2026-04-02 20:35:56 -07:00
npm-package fix(release): revert all non-Linux targets to CGO_ENABLED=0, bump v0.63.3 2026-03-30 08:58:25 -07:00
scripts Add release stability gate for upgrade safety (GH#2951) (#2963) 2026-04-01 17:00:25 -07:00
tests Merge pull request #2821 from harry-miller-trimble/fix/idempotent-claim 2026-03-26 08:40:51 -07:00
website /{README.md,cmd,docs,internal,website}: doc updates 2026-03-28 13:47:20 -07:00
winget docs: replace "git-backed" with "Dolt-powered", add git-free usage guide 2026-03-13 11:44:50 -07: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 ignore ampcode .amp local state 2026-03-24 10:31:52 -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): revert all non-Linux targets to CGO_ENABLED=0, bump v0.63.3 2026-03-30 08:58:25 -07: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 chore: add crew workflow guardrails (block PR creation, document push-to-main) 2026-03-20 18:26:13 -07: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 feat: export WispFilter type from root package (#2868) 2026-04-02 19:22:06 -07:00
beads_test.go feat: expose replication and VC interfaces in public API (fix-merge PR #2772) 2026-03-26 19:32:32 -07: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(release): revert all non-Linux targets to CGO_ENABLED=0, bump v0.63.3 2026-03-30 08:58:25 -07: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 dead dual-mode test framework references from CONTRIBUTING.md (#2958) 2026-04-02 19:18:48 -07:00
default.nix fix(release): revert all non-Linux targets to CGO_ENABLED=0, bump v0.63.3 2026-03-30 08:58:25 -07:00
FEDERATION-SETUP.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07: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 fix(flake): override go_1_25 and fix vendorHash 2026-03-13 19:24:43 +00:00
go.mod fix(deps): update module github.com/cenkalti/backoff/v4 to v5 (#2857) 2026-04-01 06:31:32 -07:00
go.sum chore(deps): bump charm.land/lipgloss/v2 from 2.0.1 to 2.0.2 (#2919) 2026-04-01 06:30:42 -07:00
install.ps1 [codex] Fix installer ICU/CGO fallback handling (#2965) 2026-04-01 16:52:53 -07:00
LICENSE Initial commit: Beads issue tracker with security fixes 2025-10-11 20:07:36 -07:00
Makefile Add release stability gate for upgrade safety (GH#2951) (#2963) 2026-04-01 17:00:25 -07:00
NEWSLETTER.md chore: bump version to 0.62.0 2026-03-21 19:50:38 -07: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 /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
RELEASING.md Add release stability gate for upgrade safety (GH#2951) (#2963) 2026-04-01 17:00:25 -07:00
renovate.json Add renovate.json 2026-02-19 04:00:32 +00:00
SECURITY.md Expand SECURITY.md with tracker integration trust model 2026-03-30 09:13:14 -07: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 graph issue tracker for AI agents, powered by Dolt.

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. See Git-Free Usage below.

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.

Building from Source

Building from source requires CGO (a C compiler). The embedded Dolt engine links against C libraries.

# Install dependencies
# macOS: xcode-select --install && brew install icu4c
# Ubuntu/Debian: sudo apt install build-essential
# Fedora: sudo dnf install gcc gcc-c++

# Build and install
make install

CGO_ENABLED=1 is set automatically by the Makefile. On macOS, Homebrew's icu4c paths are detected automatically. On Windows, MinGW or MSYS2 provides the C compiler (ICU is not required — a pure-Go fallback is used).

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/ANTIVIRUS.md for Windows AV false-positive guidance and verification workflow.

💾 Storage Modes

Beads uses Dolt as its database. Two modes are available:

Embedded Mode (default)

bd init

Dolt runs in-process — no external server needed. Data lives in .beads/embeddeddolt/. Single-writer only (file locking enforced). This is the recommended mode for most users.

Server Mode

bd init --server

Connects to an external dolt sql-server. Data lives in .beads/dolt/. Supports multiple concurrent writers. Configure the connection with flags or environment variables:

Flag Env Var Default
--server-host BEADS_DOLT_SERVER_HOST 127.0.0.1
--server-port BEADS_DOLT_SERVER_PORT 3307
--server-user BEADS_DOLT_SERVER_USER root
BEADS_DOLT_PASSWORD (none)

Backup & Migration

Back up your database and migrate between modes using bd backup:

# Set up a backup destination and push
bd backup init /path/to/backup
bd backup sync

# Restore into a new project (any mode)
bd init           # or bd init --server
bd backup restore --force /path/to/backup

See docs/DOLT.md for full migration instructions.

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

🚀 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_DIR at a specific subdirectory
  • CI/CD — isolated task tracking without repo-level side effects
  • Evaluation/testing — ephemeral databases in /tmp

For daemon mode without git, use bd daemon start --local (see PR #433).

📝 Documentation