Add a bulk help docs writer that emits the root CLI reference and website command pages from a single Cobra walk. Update the shell generator to call that mode, preserve the pure-Go docs binary guard, and refresh historical versioned CLI docs only when release snapshotting requests a specific version. Agent-Signature: codex-gpt-5.5-medium on behalf of matt wilkie
118 lines
3 KiB
Markdown
118 lines
3 KiB
Markdown
---
|
|
id: backup
|
|
title: bd backup
|
|
slug: /cli-reference/backup
|
|
sidebar_position: 999
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
Generated from `bd help --doc backup`
|
|
|
|
## bd 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.
|
|
|
|
```
|
|
bd backup [flags]
|
|
```
|
|
|
|
### 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]
|
|
```
|