CLI Reference

18 commands. Every backup operation. One CLI.

Commands

CommandDescription
ginkgo init <path>Initialize a backup source
ginkgo backup --source <id>Trigger a backup
ginkgo backup --source <id> --waitTrigger a backup and wait for it to finish
ginkgo sourcesList all backup sources
ginkgo snapshots --source <id>List snapshots for a source
ginkgo restore --source <id> ...Restore files from a snapshot
ginkgo progressShow backup progress
ginkgo history --source <id> ...View version history for a file
ginkgo diff --source <id> ...Diff two versions of a file
ginkgo verify --source <id>Verify backup integrity
ginkgo mount --source <id> ...Mount a snapshot as a drive
ginkgo retention apply --source <id>Apply retention policy
ginkgo retention gc --repo <path>Run garbage collection
ginkgo export --snapshot <id> ...Export a snapshot to tar or zip
ginkgo staging push <path>Push files to the staging area
ginkgo checkpoint --source <id>Create a named checkpoint
ginkgo statusShow system status overview
ginkgo versionPrint version information

Global Flags

FlagEnv VariableDefaultDescription
--tokenGINKGO_TOKENAPI authentication token
--portGINKGO_PORT9275API server port
--host127.0.0.1API server bind address