Documentation

Your backup command reference.

Run backups, list snapshots, inspect status and restore with an explicit configuration.

All guides
A technical field guide with an amber bookmark and file tiles

Ask AI about CalmBackup

See what it does, who it’s for, and whether it fits your needs.

Opens with product context and a link to this page.

View or copy the prompt

Commands

Run a backup

calmbackup run

List backups

calmbackup list

Restore a backup

calmbackup restore <backup-id>

Check status

calmbackup status

Global flags

--config <path>Override config file location
--verbose, -vVerbose output
--quiet, -qSuppress non-error output (useful for cron)

Use an explicit recovery configuration

The restore command writes to the database and directory paths in the configuration it loads. For a practice restore, use a separate machine or isolated environment and review every destination first.

calmbackup --config /path/to/recovery.yaml restore &lt;backup-id&gt;
Restores can overwrite existing data.

PostgreSQL restores use clean/if-exists behavior, MySQL imports SQL, and SQLite replaces the configured database file. Included directories are copied to configured paths. Do not use your production configuration for a rehearsal.

What the command does

The client obtains backup metadata, uses a matching local cache or downloads the encrypted archive, authenticates and decrypts it, extracts the data, and invokes the database restore. Application validation remains a separate step.

Read the complete recovery workflow →