beads/docs/cli-reference/backup.md
Steve Yegge bd73c75292 fix(claim): stop the refusal copy from teaching claim eviction (bd-at6rc)
The --claim refusal for an issue assigned to another actor said "Use
bd unclaim <id> to release it before re-claiming". In a multi-agent
fleet that copy taught exactly the wrong move: an agent's silenced
'unclaim; claim' batch loop evicted another agent's live, heartbeated
claim mid-review (wyvern incident wy-yuclk, ask wy-zs5s2).

The ownership check itself (foreign unclaim requires --force) already
landed in #4675; this completes the ask by fixing the guidance around
it:

- The open-but-assigned --claim refusal now says to coordinate with
  the holder and notes that releasing another actor's claim requires
  bd unclaim --force.
- Unclaim's ErrNotOwner rejection frames --force as an abandoned-claim
  escape hatch (crashed agent, expired lease), not a routine override.
- bd unclaim's help documents the ownership rule and points at lease
  expiry for genuinely abandoned work.

Tests pin the new coordinate-with-holder copy and assert the old
release-before-reclaiming suggestion stays gone. CLI reference
regenerated; picks up the same pre-existing auto-backup help drift
hunk as #4839 (identical content, merges cleanly either order).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-15 23:03:34 -07:00

3.6 KiB

title description
bd backup Back up your beads database

{/* AUTO-GENERATED: do not edit manually */}

Generated from bd help --doc backup.

Back up your beads database for off-machine recovery.

This is a Dolt-native database backup. It preserves the database state, including tables, branches, commit history, and working-set data. This is different from 'bd export', which writes issue records to JSONL for migration and interoperability.

Commands: bd backup init <path> Set up a backup destination (filesystem or DoltHub) bd backup sync Push to configured backup destination bd backup restore [path] Restore from a backup directory bd backup remove Remove backup destination bd backup status Show backup status

DoltHub is recommended for cloud backup: bd backup init https://doltremoteapi.dolthub.com/<user>/<repo> Set DOLT_REMOTE_USER and DOLT_REMOTE_PASSWORD for authentication.

Auto-backup default: When backup.enabled is unset, auto-backup turns ON in embedded mode if a git remote exists, and stays OFF in sql-server / shared-server mode. In server mode many bd clients share one Dolt server, and each would register a server-side backup remote under the same name pointing at its own local dir and full-sync the whole database — a self-amplifying storm. To back up a shared server, run 'bd backup' explicitly (or set backup.enabled=true and coordinate destinations). 'bd config get backup.enabled' shows the effective value and its source.

bd backup [command]

bd backup init

Configure a filesystem path or URL as a backup destination.

The path can be a local directory (external drive, NAS, Dropbox folder) or a DoltHub remote URL. If the destination was previously configured, it is updated to the new path.

Filesystem examples: bd backup add /mnt/usb/beads-backup bd backup add ~/Dropbox/beads-backup

DoltHub (recommended for cloud backup): bd backup add https://doltremoteapi.dolthub.com/myuser/beads-backup

After adding, run 'bd backup sync' to push your data.

bd backup init <path> [flags]

Aliases: add

bd backup remove

Remove the configured backup destination.

This unregisters the backup remote from Dolt and removes the local backup configuration. The backup data at the destination is not deleted.

bd backup remove [flags]

Aliases: rm

bd backup restore

Restore the beads database from a Dolt-native backup.

By default, reads from .beads/backup/ (or the configured backup directory). Optionally specify a path to a directory containing a Dolt backup.

This restores a full database backup created by 'bd backup sync' or an equivalent Dolt backup. JSONL files produced by 'bd export' are issue exports, not restore targets for this command.

Use --force to overwrite an existing database with the backup contents.

The database must already be initialized (run 'bd init' first if needed). To initialize and restore in one step, use: bd init && bd backup restore

bd backup restore [path] [flags]

Flags:

      --force   Overwrite existing database with backup contents

bd backup status

Show last backup status

bd backup status [flags]

bd backup sync

Sync the current beads database to the configured Dolt backup destination.

This pushes the entire database state (all branches, full history) to the backup location configured with 'bd backup init'.

The backup is atomic — if the sync fails, the previous backup state is preserved.

Run 'bd backup init <path>' first to configure a destination.

bd backup sync [flags]