Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.dbdock.xyz/llms.txt

Use this file to discover all available pages before exploring further.

DBdock ships a single CLI binary — dbdock — with commands for setup, backup, restore, migration, and management. Every command is documented on its own page with options, examples, and gotchas.

Command index

Setup

dbdock init

Interactive setup wizard. Run once per project.

dbdock migrate-config

Move legacy secrets from config file to environment.

Backup lifecycle

dbdock backup

Create a backup with encryption and compression.

dbdock restore

Interactive restore with smart filtering.

dbdock list

List all backups with filtering.

dbdock delete

Delete specific backups or all of them.

dbdock cleanup

Apply the retention policy.

Direct database operations

dbdock copydb

Copy a PostgreSQL database directly between two URLs.

Cross-DB migration

MongoDB ↔ PostgreSQL (see Migration section).

Diagnostics & schedules

dbdock test

Verify DB, storage, and alert config.

dbdock status

View schedules and service health.

dbdock schedule

Manage cron schedules.

Global flags

Every command supports:
FlagDescription
--help, -hShow command help
--version, -VPrint DBdock version

Exit codes

CodeMeaning
0Success
1General error
130Interrupted (Ctrl+C or SIGINT)
Commands that perform destructive actions always confirm interactively unless you pass --force (where supported).

Getting help