RESTIC-CHECK(1)

💖 restic-check(1) 💖

okay bestie, so this page lives in the restic backup(1) manual (yes, the header's a little chaotic, we don't talk about it 💅) — and it's all about the check command. let's get into it, no cap.

---

✨ NAME ✨

restic-check — check the repository for errors 🔍

---

🎀 SYNOPSIS 🎀

restic check [flags]

---

🦋 DESCRIPTION 🦋

so the check command tests your repository for errors and reports literally any error it finds. it's giving health inspector energy. 🩺

by default, check verifies the structural consistency and integrity of snapshots, trees and pack files. that's the baseline vibe check.

if you also wanna verify the integrity of the actual backed-up data, you gotta use the --read-data or --read-data-subset flags. those go deeper, fr fr.

and by default, check creates a new temporary cache directory to verify data. if you'd rather reuse the existing cache, use the --with-cache flag. iconic behaviour, honestly.

---

👑 EXIT STATUS 👑

• exit status is 0 if the command was successful ✨
• exit status is 1 if there was any error 😭
• exit status is 10 if the repository does not exist 💀
• exit status is 11 if the repository is already locked 🔒
• exit status is 12 if the password is incorrect 🙈

---

💅 OPTIONS 💅

• -h, --help[=false] — help for check 🫶
• -H, --host=[] — only consider snapshots for this host (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST)
• --path=[] — only consider snapshots including this (absolute) path (can be specified multiple times, snapshots must include all specified paths)
• --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 🎲
• --tag=[] — only consider snapshots including tag[,tag,...] (can be specified multiple times)
• --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|fastest|better|max) (default: $RESTIC_COMPRESSION)
• --http-user-agent="" — set a http user agent for outgoing http requests
• --insecure-no-password[=false] — use an empty password for the repository, must be passed to every restic command (insecure) ⚠️
• --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-extra-verify[=false] — skip additional verification of data before upload (see documentation)
• --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)
• --stuck-request-timeout=5m0s — duration after which to retry stuck requests
• --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)

---

and that's the whole page, bestie. go forth and check your repo. it's giving responsible queen behaviour 👑

generated by restic generate — Jan 2017 — from the restic backup(1) manual ✨ mwah, stay slay 💖