Live config has been YAML since v1.0.0 (per mybd-hxq investigation / PR #3714: `git show v1.0.0:internal/config/config.go` → SetConfigType("yaml")). The .beads/ tree diagram on line 23 in both the live and v1.0.0 versioned snapshots still showed config.toml. Same wholly-stale pattern as PR #3714, smaller blast radius. Other .toml references in website/docs and website/versioned_docs all refer to .formula.toml (formulas legitimately use TOML) and are correct. Out of scope (separate issue mybd-ssn): website/static/llms-full.txt also has stale config.toml references at lines 11074-11075 and 11196. That file is generated and is being brought under a freshness gate. Amp-Thread-ID: https://ampcode.com/threads/T-019dfe19-17ae-713e-bc3a-d7c9da6a117d Co-authored-by: Amp <amp@ampcode.com>
2.2 KiB
2.2 KiB
| id | title | sidebar_position |
|---|---|---|
| git-integration | Git Integration | 2 |
Git Integration
How beads integrates with git.
Overview
Beads uses git for:
- Project hosting - Your code repository also hosts beads configuration
- Hooks - Auto-sync on git operations
Data storage and sync are handled by Dolt (a version-controlled SQL database).
File Structure
.beads/
├── config.yaml # Project config (git-tracked)
├── metadata.json # Backend metadata (git-tracked)
└── dolt/ # Dolt database and server data (gitignored)
Git Hooks
Installation
bd hooks install
Installs:
- pre-commit - Triggers Dolt commit
- post-merge - Triggers Dolt sync after pull
- pre-push - Ensures Dolt sync before push
Status
bd hooks status
Uninstall
bd hooks uninstall
Conflict Resolution
Dolt handles merge conflicts at the database level using its built-in merge capabilities. When conflicts arise during sync, Dolt identifies conflicting rows and allows resolution through SQL.
# Check for and fix conflicts
bd doctor --fix
Protected Branches
Dolt stores data under refs/dolt/data, separate from Git refs. This means beads data doesn't conflict with protected Git branches — no special branch flag is needed.
Git Worktrees
Beads works in git worktrees using embedded mode:
# In worktree — just run commands directly
bd create "Task"
bd list
Branch Workflows
Feature Branch
git checkout -b feature-x
bd create "Feature X" -t feature
# Work...
bd dolt push
git push
Fork Workflow
# In fork
bd init --contributor
# Work in separate planning repo...
bd dolt push
Team Workflow
bd init --team
# All team members share the Dolt database
bd dolt pull # Pull latest changes from Dolt remote
bd dolt push # Push your changes to Dolt remote
Duplicate Detection
After merging branches:
bd duplicates --auto-merge
Best Practices
- Install hooks -
bd hooks install - Push regularly -
bd dolt pushat session end - Pull before work -
bd dolt pullto get latest issues - Worktrees use embedded mode automatically