NAME¶

restic-check - Check the repository for errors

SYNOPSIS¶

restic check [flags]

DESCRIPTION¶

The "check" command tests the repository for errors and reports any errors it finds. It can also be used to read all data and therefore simulate a restore.

By default, the "check" command will always load all data directly from the repository and not use a local cache.

EXIT STATUS¶

Exit status is 0 if the command was successful, and non-zero if there was any error.

OPTIONS¶

-h, --help[=false] help for check

--read-data[=false] read all data blobs

--read-data-subset="" read a subset of data packs, specified as 'n/t' for specific part, or either 'x%' or 'x.y%' or a size in bytes with suffixes k/K, m/M, g/G, t/T for a random subset

--with-cache[=false] use existing cache, only read uncached data from repository

OPTIONS INHERITED FROM PARENT COMMANDS¶

--cacert=[] file to load root certificates from (default: use system certificates or $RESTIC_CACERT)

--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) (default: $RESTIC_COMPRESSION)

--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)

--retry-lock=0s retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries)

--tls-client-cert="" path to a file containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)

-v, --verbose[=0] be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2)

SEE ALSO¶

restic(1)