beads/docs/getting-started/sync-setup.md
Chris Sells 54a7547b0d docs: canonical concept page, section overviews, and concept diagrams
- Rewrite docs/core-concepts/index.md as 'How Beads Works' — the one
  canonical concept page (modeled on Gas City's how-gas-city-works):
  problem-first framing, the bead -> dependencies -> ready-work loop, hash
  IDs, the formula -> proto -> molecule/wisp pipeline, gates, Dolt sync,
  federation, and storage modes, led by four mermaid diagrams. Other pages
  link here instead of re-deriving the model.
- Fact fixes caught while writing (verified against source/live help):
  hash IDs are content-derived SHA-256 (internal/types/id_generator.go),
  not random; bd pour/bd wisp/bd pin/bd hook are not commands (the real
  surface is bd mol pour, bd mol wisp, bd assign, bd update --claim);
  wisps are not stored in .beads-wisp/; cross-repo dependency syntax is
  external:<project>:<capability> (cmd/bd/dep.go); recovery index claimed
  SQLite errors in a Dolt product.
- Section overview pages: rewrite workflows/index, extend recovery,
  multi-agent, and integrations indexes to list every child with one-line
  summaries; add reference/index and put it in the nav.
- New concept diagrams: sequential-vs-hash ID merge collision
  (core-concepts/hash-ids) and embedded-vs-server mode
  (architecture/dolt).
- website/README.md: real build/verify instructions and parallel-run
  status for the Docusaurus site.
- Repoint example READMEs and page labels at the real quickstart page.
2026-07-12 10:37:07 -07:00

288 lines
7.7 KiB
Markdown

---
title: Sync Setup Guide
---
Set up beads with Dolt sync so your issues follow you across computers.
## Prerequisites
You need two tools installed on every machine:
| Tool | Minimum Version | Install |
|------|-----------------|---------|
| **bd** (beads CLI) | 0.59.0+ | See [INSTALLING.md](/getting-started/installation) |
| **Dolt** | 2.1.10+ | `brew install dolt` or [dolt install script](https://github.com/dolthub/dolt/releases/latest/download/install.sh) |
Verify both are installed:
```bash
bd version # must be 0.59.0+
dolt version # must be 2.1.10+
```
## Initial Setup (First Computer)
### 1. Initialize beads
```bash
cd your-project
bd init
```
This creates the `.beads/` directory with a Dolt database. If the git repo has
an `origin` remote, `bd init` also configures a Dolt remote named `origin`
pointing at that same git URL. Dolt stores issue data under `refs/dolt/data`,
separate from normal source branches.
### 2. Create some issues
```bash
bd create "Set up CI pipeline" -p 1 -t task
bd create "Add authentication" -p 2 -t feature
bd list
```
### 3. Verify or add a Dolt remote
In a normal git repo with `origin`, this should already be configured:
```bash
bd dolt remote list
# Expected: origin <your git origin URL>
```
If the repo had no `origin` during init, point beads at your Git remote for
sync:
```bash
# GitHub (SSH — recommended)
bd dolt remote add origin git+ssh://git@github.com/org/repo.git
# GitHub (HTTPS)
bd dolt remote add origin git+https://github.com/org/repo.git
# Other options: DoltHub, S3, GCS, local path
# See DOLT.md for all remote types
```
### 4. Push your issues
```bash
bd dolt push
```
Verify the push worked:
```bash
git ls-remote origin | grep dolt
# Expected: <hash> refs/dolt/data
```
## Existing Projects Without a Dolt Remote
Projects initialized by older versions of `bd init` may have a local embedded
Dolt database and a committed `.beads/issues.jsonl`, but no Dolt remote. Fix
that from the machine whose local database is authoritative:
```bash
bd dolt remote list
bd export -o .beads/issues.pre-remote.jsonl # optional issue audit export
bd dolt remote add origin git+ssh://git@github.com/org/repo.git
bd dolt push
```
`bd dolt remote add origin ...` writes `sync.remote` to `.beads/config.yaml`.
Commit and push that config file with your normal git workflow. Other clones can
then run `bd bootstrap` if their database is missing/stale, or `bd dolt pull`
when they already have the right database.
## Cloning to a New Computer
When you clone a repo that already has beads data on the remote, a standard `git clone` does **not** fetch `refs/dolt/data`. You need to bootstrap the Dolt database.
### Quick path: bd bootstrap
On recent versions of bd, `bd bootstrap` handles everything automatically:
```bash
git clone git@github.com:org/repo.git
cd repo
bd bootstrap
```
`bd bootstrap` auto-detects `refs/dolt/data` on origin, clones the Dolt database, and configures the remote. Verify with:
```bash
bd list # should show your issues
bd vc log # should show commit history
```
If `bd bootstrap` succeeds, you're done — skip to [Day-to-day Sync](#day-to-day-sync).
### Manual path (if bootstrap fails)
If `bd bootstrap` doesn't work (older bd versions, unusual remote configs), follow these steps:
**Step 1: Confirm the remote has beads data**
```bash
git ls-remote origin | grep dolt
# Expected: <hash> refs/dolt/data
# If missing, the remote has no beads data — use bd init normally.
```
**Step 2: Initialize beads**
```bash
bd init
```
This creates `.beads/` with an empty database. Ignore any warnings about `bd bootstrap` — we'll replace the empty database manually.
**Step 3: Stop the Dolt server**
```bash
bd dolt stop
```
**Step 4: Find your database name and remove the empty database**
```bash
# Check your database name
cat .beads/metadata.json # look for "dolt_database"
```
The `dolt_database` field is your `<dbname>` (typically the repo name).
```bash
# Remove the empty database
rm -rf .beads/dolt/<dbname>/
```
**Step 5: Clone the Dolt data from the remote**
```bash
cd .beads/dolt
dolt clone git@github.com:org/repo.git <dbname>
cd ../..
```
**Step 6: Start the server and migrate**
```bash
bd dolt start
bd migrate --yes
```
**Step 7: Ensure the remote is registered**
```bash
bd dolt remote add origin git+ssh://git@github.com/org/repo.git
```
If you see "remote already exists", that's fine — `dolt clone` already set it up.
**Step 8: Verify**
```bash
bd dolt remote list # should show origin
bd list # should show your issues
```
## Day-to-day Sync
Once set up on both machines, sync is two commands:
```bash
# Push your changes to the remote
bd dolt push
# Pull changes from the remote
bd dolt pull
```
### Typical workflow
```
Machine A Machine B
───────── ─────────
bd create "New task" -p 1
bd dolt push
bd dolt pull
bd update bd-a1b2 --claim
bd close bd-a1b2 --reason "Done"
bd dolt push
bd dolt pull
bd list # sees the closed task
```
### Important rules
- **Always use `bd dolt ...` commands** — never run raw `dolt` CLI commands while the Dolt server is running. It causes journal corruption.
- **Commit before pulling** — if you have uncommitted working set changes, `bd dolt pull` will fail with "cannot merge with uncommitted changes". Run `bd dolt commit` first.
- **Push before switching machines** — unpushed changes only exist locally.
- **Do not use JSONL as sync** — `.beads/issues.jsonl` is an export for viewers and interchange. It is not the source of truth, not a full database backup, and cannot safely reconcile deletes or pruning.
## Troubleshooting
### "no common ancestor" on push
A stale `refs/dolt/data` from a previous database is conflicting. Clear it and retry:
```bash
git update-ref -d refs/dolt/data
bd dolt push
```
### "cannot merge with uncommitted changes" on pull
Commit your working set first:
```bash
bd dolt commit
bd dolt pull
```
### "no store available" on push or commit
This was a bug in bd < 0.59.0. Upgrade bd:
```bash
brew upgrade beads
# or re-run the install script
```
### bd list shows nothing after clone
The Dolt database wasn't bootstrapped. Either run `bd bootstrap` or follow the [manual path](#manual-path-if-bootstrap-fails) above.
### Stale lock files after crash
```bash
bd doctor --fix --yes
```
**WARNING**: Do NOT manually remove files inside `.dolt/` directories (including
`noms/LOCK`). These are Dolt-internal files and removing them **will cause
unrecoverable data corruption**. Dolt manages these files itself.
### "fatal: Unable to read current working directory"
The Dolt server's working directory no longer exists (common after branch switches). Restart it:
```bash
bd dolt stop
bd dolt start
```
## See Also
- [SYNC_CONCEPTS.md](/core-concepts/sync-concepts) — The conceptual model behind this setup (why Dolt is the source of truth, what JSONL is for)
- [Quick Start](/getting-started/quickstart) — Getting started with beads
- [DOLT.md](/architecture/dolt) — Dolt backend details, server modes, federation, remote types, and sync modes
- [INSTALLING.md](/getting-started/installation) — Installation for all platforms
## Attribution
This guide was inspired by [@leonletto](https://github.com/leonletto)'s community setup guide at [leonletto.github.io/thrum](https://leonletto.github.io/thrum/docs.html#guides/beads-setup.html), which documented the end-to-end setup and sync process including the manual bootstrap workflow. Thanks for contributing to the beads community!