Skip to content

Commit 2c5cfcb

Browse files
authored
Merge PR #2552: docs: replace git-backed with Dolt-powered, document git-free usage
docs: replace "git-backed" with "Dolt-powered", document git-free usage
2 parents 259925c + e31428f commit 2c5cfcb

15 files changed

Lines changed: 56 additions & 25 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Project Overview
44

5-
**beads** (command: `bd`) is a Git-backed issue tracker designed for AI-supervised coding workflows. We dogfood our own tool for all task tracking.
5+
**beads** (command: `bd`) is a Dolt-powered issue tracker designed for AI-supervised coding workflows. Git integration is optional. We dogfood our own tool for all task tracking.
66

77
**Key Features:**
88
- Dependency-aware issue tracking

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# bd - Beads
22

3-
**Distributed, git-backed graph issue tracker for AI agents.**
3+
**Distributed graph issue tracker for AI agents, powered by [Dolt](https://github.com/dolthub/dolt).**
44

55
**Platforms:** macOS, Linux, Windows, FreeBSD
66

@@ -55,7 +55,7 @@ Beads supports hierarchical IDs for epics:
5555
* `bd-a3f8.1` (Task)
5656
* `bd-a3f8.1.1` (Sub-task)
5757

58-
**Stealth Mode:** Run `bd init --stealth` to use Beads locally without committing files to the main repo. Perfect for personal use on shared projects.
58+
**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](#-git-free-usage) below.
5959

6060
**Contributor vs Maintainer:** When working on open-source projects:
6161

@@ -74,6 +74,37 @@ Beads supports hierarchical IDs for epics:
7474

7575
See [docs/COMMUNITY_TOOLS.md](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.
7676

77+
## 🚀 Git-Free Usage
78+
79+
Beads works without git. The Dolt database is the storage backend — git
80+
integration (hooks, repo discovery, identity) is optional.
81+
82+
```bash
83+
# Initialize without git
84+
export BEADS_DIR=/path/to/your/project/.beads
85+
bd init --quiet --stealth
86+
87+
# All core commands work with zero git calls
88+
bd create "Fix auth bug" -p 1 -t bug
89+
bd ready --json
90+
bd update bd-a1b2 --claim
91+
bd prime
92+
bd close bd-a1b2 "Fixed"
93+
```
94+
95+
`BEADS_DIR` tells bd where to put the `.beads/` database directory,
96+
bypassing git repo discovery. `--stealth` sets `no-git-ops: true` in
97+
config, disabling all git hook installation and git operations.
98+
99+
This is useful for:
100+
- **Non-git VCS** (Sapling, Jujutsu, Piper) — no `.git/` directory needed
101+
- **Monorepos** — point `BEADS_DIR` at a specific subdirectory
102+
- **CI/CD** — isolated task tracking without repo-level side effects
103+
- **Evaluation/testing** — ephemeral databases in `/tmp`
104+
105+
For daemon mode without git, use `bd daemon start --local`
106+
(see [PR #433](https://github.com/steveyegge/beads/pull/433)).
107+
77108
## 📝 Documentation
78109

79110
* [Installing](docs/INSTALLING.md) | [Agent Workflow](AGENT_INSTRUCTIONS.md) | [Copilot Setup](docs/COPILOT_INTEGRATION.md) | [Articles](ARTICLES.md) | [Sync Branch Mode](docs/PROTECTED_BRANCHES.md) | [Troubleshooting](docs/TROUBLESHOOTING.md) | [FAQ](docs/FAQ.md)

claude-plugin/skills/beads/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: beads
33
description: >
4-
Git-backed issue tracker for multi-session work with dependencies and persistent
4+
Dolt-powered issue tracker for multi-session work with dependencies and persistent
55
memory across conversation compaction. Use when work spans sessions, has blockers,
66
or needs context recovery after compaction. Trigger with "create task", "what's
77
ready", "track this work", "resume after compaction". Make sure to use this skill
@@ -25,7 +25,7 @@ Graph-based issue tracker that survives conversation compaction. Provides persis
2525
| bd (persistent) | TodoWrite (ephemeral) |
2626
|-----------------|----------------------|
2727
| Multi-session, dependencies, compaction survival | Single-session linear tasks |
28-
| Git-backed team sync | Conversation-scoped |
28+
| Dolt-backed team sync | Conversation-scoped |
2929

3030
See [BOUNDARIES.md](${CLAUDE_SKILL_DIR}/resources/BOUNDARIES.md) for detailed comparison.
3131

@@ -36,7 +36,7 @@ bd --version # Requires v0.60.0+
3636
```
3737

3838
- **bd CLI** installed and in PATH
39-
- **Git repository** (bd requires git for sync)
39+
- **Git repository** (optional — use `BEADS_DIR` + `--stealth` for git-free operation)
4040
- **Initialization**: `bd init` run once (humans do this, not agents)
4141

4242
## CLI Reference

claude-plugin/skills/beads/resources/BOUNDARIES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Need to resume work after significant time with full context.
8686
- Complex features split across sprints
8787
- Research projects with long investigation periods
8888

89-
**Why bd wins**: Git-backed database persists indefinitely. All context, decisions, and history available on resume. No relying on conversation scrollback or markdown files.
89+
**Why bd wins**: Dolt-backed database persists indefinitely. All context, decisions, and history available on resume. No relying on conversation scrollback or markdown files.
9090

9191
---
9292

@@ -142,7 +142,7 @@ Just need a checklist to show progress to user.
142142

143143
| Aspect | bd | TodoWrite |
144144
|--------|-----|-----------|
145-
| **Persistence** | Git-backed, survives compaction | Session-only, lost after conversation |
145+
| **Persistence** | Dolt-backed, survives compaction | Session-only, lost after conversation |
146146
| **Dependencies** | Graph-based, automatic ready detection | Manual, no automatic tracking |
147147
| **Discoverability** | `bd ready` surfaces work | Scroll conversation for todos |
148148
| **Complexity** | Handles nested epics, blockers | Flat list only |

docs/ARCHITECTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document describes bd's overall architecture - the data model, sync mechani
44

55
## The Two-Layer Data Model
66

7-
bd's core design enables a distributed, git-backed issue tracker that feels like a centralized database. The architecture has two synchronized layers:
7+
bd's core design enables a distributed, Dolt-powered issue tracker that feels like a centralized database. The architecture has two synchronized layers:
88

99
```
1010
┌─────────────────────────────────────────────────────────────────┐

docs/CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
**beads** (command: `bd`) is a git-backed issue tracker for AI-supervised coding workflows. We dogfood our own tool.
7+
**beads** (command: `bd`) is a Dolt-powered issue tracker for AI-supervised coding workflows. Git integration is optional — see `BEADS_DIR` + `--stealth` for git-free operation. We dogfood our own tool.
88

99
**IMPORTANT**: See [AGENTS.md](../AGENTS.md) for complete workflow instructions, bd commands, and development guidelines.
1010

npm-package/INTEGRATION_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ bd init --quiet 2>&1 | grep -v "already initialized"
224224
-**Persistent memory**: Issue context survives session resets
225225
-**Structured planning**: Dependencies create clear work order
226226
-**Automatic setup**: No manual intervention needed
227-
-**Git-backed**: All issues are version controlled
227+
-**Dolt-backed**: All issues are version controlled
228228
-**Fast queries**: `bd ready` finds work instantly
229229

230230
### For Humans

npm-package/LAUNCH.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ Create `.github/workflows/publish-npm.yml` to auto-publish on GitHub releases.
124124
-**Platform detection** - Works on macOS, Linux, Windows
125125
-**Full feature parity** - Native SQLite, all commands work
126126
-**Claude Code ready** - Perfect for SessionStart hooks
127-
-**Git-backed** - Issues version controlled
128-
-**Multi-agent** - Shared database via git
127+
-**Dolt-backed** - Issues version controlled
128+
-**Multi-agent** - Shared database via Dolt remotes
129129

130130
## 📈 Package Stats
131131

scripts/update-winget.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ PackageUrl: https://github.com/steveyegge/beads
8181
License: MIT
8282
LicenseUrl: https://github.com/steveyegge/beads/blob/main/LICENSE
8383
Copyright: Copyright (c) 2024 Steve Yegge
84-
ShortDescription: Distributed, git-backed graph issue tracker for AI agents
84+
ShortDescription: Distributed, Dolt-powered graph issue tracker for AI agents
8585
Description: |
86-
beads (bd) is a distributed, git-backed graph issue tracker designed for AI-supervised coding workflows.
86+
beads (bd) is a distributed, Dolt-powered graph issue tracker designed for AI-supervised coding workflows.
8787
It provides a persistent, structured memory for coding agents, replacing messy markdown plans with a
8888
dependency-aware graph that allows agents to handle long-horizon tasks without losing context.
8989
Moniker: bd

website/docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: /
77

88
# Beads Documentation
99

10-
**Beads** (`bd`) is a git-backed issue tracker designed for AI-supervised coding workflows.
10+
**Beads** (`bd`) is a Dolt-powered issue tracker designed for AI-supervised coding workflows.
1111

1212
## Why Beads?
1313

0 commit comments

Comments
 (0)