restic - Man Page
Backup and restore files
Examples (TL;DR)
- Initialize a backup repository in the specified local directory:
restic init --repo path/to/repository
- Backup a directory to the repository:
restic --repo path/to/repository backup path/to/directory
- Show backup snapshots currently stored in the repository:
restic --repo path/to/repository snapshots
- Restore a specific backup snapshot to a target directory:
restic --repo path/to/repository restore latest|snapshot_id --target path/to/target
- Restore a specific path from a specific backup to a target directory:
restic --repo path/to/repository restore snapshot_id --target path/to/target --include path/to/restore
- Clean up the repository and keep only the most recent snapshot of each unique backup:
restic forget --keep-last 1 --prune
Synopsis
restic [flags]
Description
restic is a backup program which allows saving multiple revisions of files and directories in an encrypted repository stored on different backends.
Options
- --cacert=[]
file
to load root certificates from (default: use system certificates)- --cache-dir="" set the cache
directory
. (default: use system default cache directory)
--cleanup-cache[=false] auto remove old cache directories
--compression=auto compression mode (only available for repository format version 2), one of (auto|off|max)
-h, --help[=false] help for restic
--insecure-tls[=false] skip TLS certificate verification when connecting to the repository (insecure)
--json[=false] set output mode to JSON for commands that support it
- --key-hint=""
key
ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
--limit-download=0 limits downloads to a maximum rate in KiB/s. (default: unlimited)
--limit-upload=0 limits uploads to a maximum rate in KiB/s. (default: unlimited)
--no-cache[=false] do not use a local cache
--no-lock[=false] do not lock the repository, this allows some operations on read-only repositories
- -o, --option=[] set extended option (
key=value
, can be specified multiple times)
--pack-size=0 set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
- --password-command="" shell
command
to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)- -p, --password-file=""
file
to read the repository password from (default: $RESTIC_PASSWORD_FILE)
-q, --quiet[=false] do not output comprehensive progress report
- -r, --repo=""
repository
to backup to or restore from (default: $RESTIC_REPOSITORY)- --repository-file=""
file
to read the repository location from (default: $RESTIC_REPOSITORY_FILE)- --tls-client-cert="" path to a
file
containing PEM encoded TLS client certificate and private key- -v, --verbose[=0] be verbose (specify multiple times or a level using --verbose=
n
, max level/times is 3)
See Also
restic-backup(1), restic-cache(1), restic-cat(1), restic-check(1), restic-copy(1), restic-diff(1), restic-dump(1), restic-find(1), restic-forget(1), restic-generate(1), restic-init(1), restic-key(1), restic-list(1), restic-ls(1), restic-migrate(1), restic-mount(1), restic-prune(1), restic-rebuild-index(1), restic-recover(1), restic-restore(1), restic-self-update(1), restic-snapshots(1), restic-stats(1), restic-tag(1), restic-unlock(1), restic-version(1)
Referenced By
restic-backup(1), restic-cache(1), restic-cat(1), restic-check(1), restic-copy(1), restic-diff(1), restic-dump(1), restic-find(1), restic-forget(1), restic-generate(1), restic-init(1), restic-key(1), restic-list(1), restic-ls(1), restic-migrate(1), restic-mount(1), restic-prune(1), restic-rebuild-index(1), restic-recover(1), restic-restore(1), restic-self-update(1), restic-snapshots(1), restic-stats(1), restic-tag(1), restic-unlock(1), restic-version(1).