Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

backup download-artifact

Download an existing backup file from the object store to the local.

Command Format:

peppykeep backup download-artifact --remote-key <REMOTE_KEY> --output-file <FILE> [--apply] [--config-home <DIR>]

Description

  • --remote-key<REMOTE_KEY>: The object key in the object store, for example u2/your-file.ppke.
  • <FILE>--output-file: Local output file path.
  • --apply: Really perform the download; only the check information is output by default.
  • --config-home<DIR>: configuration directory.

Behaviour description

  • Outputs bucket, provider, remote key, and local output path without `--apply’.
  • With --apply, read the [object_storage] configuration in bak.toml and perform the download.
  • When provider = "s3", breakpoint continuation is supported.
  • When the local file already exists and is smaller than the remote object, the download continues from the existing length.
  • When the local file size is already equal to the remote object size, it is directly considered completed.
  • The command automatically creates a parent directory for `--output-file’.

Usage Sample

peppykeep backup download-artifact --remote-key u2/u2-bak_2026_03_20_12_00_00.ppke --output-file /tmp/u2-bak_2026_03_20_12_00_00.ppke --config-home /path/to/user/.peppykeep/u2-tmp
peppykeep backup download-artifact --apply --remote-key u2/u2-bak_2026_03_20_12_00_00.ppke --output-file /tmp/u2-bak_2026_03_20_12_00_00.ppke --config-home /path/to/user/.peppykeep/u2-tmp

Continue decryption verification after download:

peppykeep backup download-artifact --apply --remote-key u2/u2-bak_2026_03_20_12_00_00.ppke --output-file /tmp/u2-bak_2026_03_20_12_00_00.ppke --config-home /path/to/user/.peppykeep/u2-tmp
ppk decrypt --input /tmp/u2-bak_2026_03_20_12_00_00.ppke --output /tmp/u2-bak_2026_03_20_12_00_00.verify.ppk --apply --config-home /path/to/user/.peppykeep/u2-tmp --prompt-for-private-key-passphrase