CLI

This page provides a reference for the backupman command-line interface.

Main Command

The main backupman command is used to manage backups.

Usage:

backupman [command]

Global Flags:

Flag	Description	Default
`-c`, `--config`	Path to the config file.	`./config.yml`
`-h`, `--help`	Help for `backupman`.

Generate the autocompletion script for the specified shell.

Usage:

backupman completion [shell]

Perform a health check on the backup system.

Usage:

backupman health

Retry a failed backup.

Usage:

backupman retry [id]

Arguments:

Argument	Description
`id`	The ID of the failed backup to retry.

Run the backup.

Usage:

backupman run

Serve the backup manager.

Usage:

backupman serve

Flags:

Flag	Description	Default
`-p`, `--port`	Port to run the server on.	`8080`

Display the version information of backupman.

Usage:

backupman version