Every command accepts --config, --log-level and --log-format.

Commands marked as internal are hidden from --help: they run inside helper containers, not by hand.

dockup

Every command, with its global flags.

$ dockup --help
Dockup is a single-container backup agent for a Docker host.

Volumes declare their own backup policy with dockup.* labels, while
destinations, schedules and secrets live in Dockup's own configuration.

Usage:
  dockup [flags]
  dockup [command]

Available Commands:
  backup         Run a backup now
  completion     Generate the autocompletion script for the specified shell
  config         Inspect and validate the configuration
  daemon         Run Dockup and watch Docker for labelled sources
  healthcheck    Check the health endpoint of a running Dockup
  help           Help about any command
  list           List the archives stored for a source
  plan           Show which sources would be backed up, and when
  prune          Apply retention policies without backing up
  restore        Restore an archive into its volume or bind path
  status         Show sources, their last runs and any problems
  version        Print version information

Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
  -h, --help                help for dockup
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

Use "dockup [command] --help" for more information about a command.

dockup daemon

Run the agent: discovery, scheduling, health and metrics.

$ dockup daemon --help
Runs Dockup in the foreground: it discovers volumes and containers, resolves
their backup policy, schedules backups, keeps watching for changes and serves
health and metrics endpoints on the configured listen address.

Usage:
  dockup daemon [flags]

Flags:
  -h, --help                help for daemon
      --interval duration   how often to re-read Docker state as a safety net (default 1m0s)

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

dockup plan

Show which sources would be backed up, and when.

$ dockup plan --help
Reads the Docker daemon and the configuration, then prints the
resolved backup sources with their schedule, targets and retention.
Nothing is archived and nothing is written.

Usage:
  dockup plan [flags]

Flags:
  -h, --help       help for plan
      --json       print JSON instead of a table
      --now time   evaluate next run times relative to this timestamp (default 2026-11-02T12:14:32.544116261Z)

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

dockup backup

Run a backup now, for every source or the ones you name.

$ dockup backup --help
Archives the selected sources immediately, uploads them to their targets and
prunes old archives. Without --source every valid source is backed up once.

Usage:
  dockup backup [flags]

Flags:
      --dry-run          show what would be backed up without archiving anything
  -h, --help             help for backup
      --source strings   source id or name (repeatable); defaults to every valid source

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

dockup prune

Apply retention policies without backing up.

$ dockup prune --help
Apply retention policies without backing up

Usage:
  dockup prune [flags]

Flags:
      --dry-run          only show what would be deleted
  -h, --help             help for prune
      --source strings   source id or name (repeatable); defaults to every valid source

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

dockup list

List the archives stored for a source.

$ dockup list --help
List the archives stored for a source

Usage:
  dockup list [flags]

Flags:
  -h, --help             help for list
      --json             print JSON instead of a table
      --source strings   source id or name (repeatable); defaults to every valid source
      --target strings   target name (repeatable); defaults to the targets of each source

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

dockup restore

Stream an archive back into its volume or bind path.

$ dockup restore --help
Streams an archive back into the source it was taken from. Existing data is
only overwritten with --force; use --dry-run to list what an archive contains.

Usage:
  dockup restore [flags]

Flags:
      --archive string   archive key, or "latest" (default "latest")
      --dry-run          list the archive contents without restoring
      --force            overwrite the target even when it is not empty
  -h, --help             help for restore
      --source string    source id or name to restore (required)
      --target string    target to read from (defaults to the first target of the source)

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

dockup status

Sources, their last runs and any problems.

$ dockup status --help
Combines the live plan (read from Docker) with the run history stored in
the state volume. Works without a Docker daemon: history is still shown.

Usage:
  dockup status [flags]

Flags:
  -h, --help          help for status
      --history int   also print the N most recent runs
      --json          print JSON instead of tables

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

dockup config

Inspect and validate the configuration.

$ dockup config --help
Inspect and validate the configuration

Usage:
  dockup config [command]

Available Commands:
  schedules   List configured schedules
  show        Print the effective configuration with secrets redacted
  targets     List configured targets
  validate    Validate the configuration file and exit

Flags:
  -h, --help   help for config

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

Use "dockup config [command] --help" for more information about a command.

dockup healthcheck

Probe the health endpoint (used by the container HEALTHCHECK).

$ dockup healthcheck --help
Queries /readyz on the configured listen address. It exists because the
image is distroless: neither curl nor wget is available inside the container,
so Docker HEALTHCHECK and compose healthchecks use this command.

Usage:
  dockup healthcheck [flags]

Flags:
  -h, --help            help for healthcheck
      --wait duration   keep retrying for this long before failing

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error

dockup version

Print build metadata.

$ dockup version --help
Print version information

Usage:
  dockup version [flags]

Flags:
  -h, --help   help for version
      --json   print JSON instead of a single line

Global Flags:
      --config string       configuration file (default $DOCKUP_CONFIG or /etc/dockup/dockup.yml)
      --log-format string   log format: json or text
      --log-level string    log level: debug, info, warn, error