Command-line interface

Sentinel is a single binary with eleven top-level commands. Every command accepts --help, and --help is authoritative; this reference is checked against it.

sentinel --help
sentinel <command> --help

Commands

Command	Purpose
backup	Run a database backup, and inspect or verify existing ones
restore	Manage backup restoration and recovery
schedule	Manage automated backup and restore scheduling
monitor	Monitor backup history and statistics
retention	Manage backup retention policies
config	Manage configuration files
db	Database schema and migration management
security	Security key management
storage	Storage backend management
repair	Reconcile internal state across monitor rows, manifests, artifacts, and locks
version	Print Sentinel build metadata

Cobra also supplies help and completion, which behave as they do in any Cobra program.

Global flags

The root command carries only two flags:

Flag	Description
-h, --help	Help for the command
-v, --version	Version for sentinel

--config is not a global flag. Each command that reads a configuration file registers its own, which is why every example on this site repeats --config sentinel.yaml rather than setting it once.

caution

Three backup subcommands cannot be run today

sentinel backup chain-status, chain-list, and force-full require a configuration file but do not register a --config flag, and the one on sentinel backup is not inherited. They fail whether the flag is passed or not. See sentinel backup for detail.

{/* sources: internal/cli/root.go, internal/cli/backup.go, internal/cli/restore.go, internal/cli/schedule.go */}