← GoBack projectGoBack / Documentation

Commands

Current CLI reference for implemented commands (`start` and `decrypt`) and their flag behavior.

goback start

Starts the backup daemon. The `--dir` flag is required.

goback start --dir /etc/goback
-d, --dir <path>
GoBack base directory containing `config.yml` and `specs.d`.

goback decrypt

Decrypts an encrypted backup archive.

goback decrypt <archive> [spec] [flags]
-k, --key <value>
Directly provide a decryption key.
-d, --dir <path>
Resolve key from `config.yml` and optionally from a spec.
-o, --output <file>
Output path for decrypted data (optional).

Decrypt Key Resolution

  1. 1.Use `--key` if supplied.
  2. 2.Else if spec argument is provided and has `encryption_key`, use that.
  3. 3.Else use `encryption_key` from `config.yml`.
  4. 4.If none is found, command exits with error.
# explicit key
goback decrypt /tmp/backup.tar.gz.enc --key "my-key"

# resolve key from /etc/goback/config.yml
goback decrypt /tmp/backup.tar.gz.enc --dir /etc/goback

# prefer spec encryption_key when provided
goback decrypt /tmp/backup.tar.gz.enc daily.yml --dir /etc/goback