584608a14e
Cherry-picked website/, scripts/generate-llms-full.sh, and deploy-docs.yml from joyshmitz's PR. Fixed workflow to trigger on main branch instead of docs/docusaurus-site. Features: - Docusaurus documentation site with llms.txt support - Environment-variable driven config (defaults to steveyegge org) - Automated llms-full.txt generation from docs - GitHub Pages deployment workflow Co-authored-by: joyshmitz <joyshmitz@users.noreply.github.com> 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Executed-By: beads/crew/dave Rig: beads Role: crew
209 lines
3.6 KiB
Markdown
209 lines
3.6 KiB
Markdown
---
|
|
id: sync
|
|
title: Sync & Export
|
|
sidebar_position: 6
|
|
---
|
|
|
|
# Sync & Export Commands
|
|
|
|
Commands for synchronizing with git.
|
|
|
|
## bd sync
|
|
|
|
Full sync cycle: export, commit, push.
|
|
|
|
```bash
|
|
bd sync [flags]
|
|
```
|
|
|
|
**What it does:**
|
|
1. Exports database to `.beads/issues.jsonl`
|
|
2. Stages the JSONL file
|
|
3. Commits with auto-generated message
|
|
4. Pushes to remote
|
|
|
|
**Flags:**
|
|
```bash
|
|
--json JSON output
|
|
--dry-run Preview without changes
|
|
```
|
|
|
|
**Examples:**
|
|
```bash
|
|
bd sync
|
|
bd sync --json
|
|
```
|
|
|
|
**When to use:**
|
|
- End of work session
|
|
- Before switching branches
|
|
- After significant changes
|
|
|
|
## bd export
|
|
|
|
Export database to JSONL.
|
|
|
|
```bash
|
|
bd export [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
```bash
|
|
--output, -o Output file (default: .beads/issues.jsonl)
|
|
--dry-run Preview without writing
|
|
--json JSON output
|
|
```
|
|
|
|
**Examples:**
|
|
```bash
|
|
bd export
|
|
bd export -o backup.jsonl
|
|
bd export --dry-run
|
|
```
|
|
|
|
## bd import
|
|
|
|
Import from JSONL file.
|
|
|
|
```bash
|
|
bd import -i <file> [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
```bash
|
|
--input, -i Input file (required)
|
|
--dry-run Preview without changes
|
|
--orphan-handling How to handle missing parents
|
|
--dedupe-after Run duplicate detection after import
|
|
--json JSON output
|
|
```
|
|
|
|
**Orphan handling modes:**
|
|
| Mode | Behavior |
|
|
|------|----------|
|
|
| `allow` | Import orphans without validation (default) |
|
|
| `resurrect` | Restore deleted parents as tombstones |
|
|
| `skip` | Skip orphaned children with warning |
|
|
| `strict` | Fail if parent missing |
|
|
|
|
**Examples:**
|
|
```bash
|
|
bd import -i .beads/issues.jsonl
|
|
bd import -i backup.jsonl --dry-run
|
|
bd import -i issues.jsonl --orphan-handling resurrect
|
|
bd import -i issues.jsonl --dedupe-after --json
|
|
```
|
|
|
|
## bd migrate
|
|
|
|
Migrate database schema.
|
|
|
|
```bash
|
|
bd migrate [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
```bash
|
|
--inspect Show migration plan (for agents)
|
|
--dry-run Preview without changes
|
|
--cleanup Remove old files after migration
|
|
--yes Skip confirmation
|
|
--json JSON output
|
|
```
|
|
|
|
**Examples:**
|
|
```bash
|
|
bd migrate --inspect --json
|
|
bd migrate --dry-run
|
|
bd migrate
|
|
bd migrate --cleanup --yes
|
|
```
|
|
|
|
## bd hooks
|
|
|
|
Manage git hooks.
|
|
|
|
```bash
|
|
bd hooks <subcommand> [flags]
|
|
```
|
|
|
|
**Subcommands:**
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `install` | Install git hooks |
|
|
| `uninstall` | Remove git hooks |
|
|
| `status` | Check hook status |
|
|
|
|
**Examples:**
|
|
```bash
|
|
bd hooks install
|
|
bd hooks status
|
|
bd hooks uninstall
|
|
```
|
|
|
|
## Auto-Sync Behavior
|
|
|
|
### With Daemon (Default)
|
|
|
|
The daemon handles sync automatically:
|
|
- Exports to JSONL after changes (5s debounce)
|
|
- Imports from JSONL when newer
|
|
|
|
### Without Daemon
|
|
|
|
Use `--no-daemon` flag:
|
|
- Changes only written to SQLite
|
|
- Must manually export/sync
|
|
|
|
```bash
|
|
bd --no-daemon create "Task"
|
|
bd export # Manual export needed
|
|
```
|
|
|
|
## Conflict Resolution
|
|
|
|
### Merge Driver (Recommended)
|
|
|
|
Install the beads merge driver:
|
|
|
|
```bash
|
|
bd init # Prompts for merge driver setup
|
|
```
|
|
|
|
The driver automatically:
|
|
- Merges non-conflicting changes
|
|
- Preserves both sides for real conflicts
|
|
- Uses latest timestamp for same-issue edits
|
|
|
|
### Manual Resolution
|
|
|
|
```bash
|
|
# After merge conflict
|
|
git checkout --ours .beads/issues.jsonl
|
|
bd import -i .beads/issues.jsonl
|
|
bd sync
|
|
```
|
|
|
|
## Deletion Tracking
|
|
|
|
Deletions sync via `.beads/deletions.jsonl`:
|
|
|
|
```bash
|
|
# Delete issue
|
|
bd delete bd-42
|
|
|
|
# View deletions
|
|
bd deleted
|
|
bd deleted --since=30d
|
|
|
|
# Deletions propagate via git
|
|
git pull # Imports deletions from remote
|
|
```
|
|
|
|
## Best Practices
|
|
|
|
1. **Always sync at session end** - `bd sync`
|
|
2. **Install git hooks** - `bd hooks install`
|
|
3. **Use merge driver** - Avoids manual conflict resolution
|
|
4. **Check sync status** - `bd info` shows daemon/sync state
|