RESTIC-CAT(1)

🐱 restic-cat(1) — no cap, the manual

okay so bestie, welcome to the restic backup(1) manual page, specifically the lil corner of it about restic cat. yes it's a whole mood. sit down, grab a strawberry 🍓, and let's read this together.

---

✨ NAME ✨

restic-cat — print internal objects to stdout 💅

---

🌸 SYNOPSIS 🌸

restic cat [flags] [masterkey|config|pack ID|blob ID|snapshot ID|index
ID|key ID|lock ID|tree snapshot:subfolder]

like. look at all those options. she contains multitudes. 👑

---

🦋 DESCRIPTION 🦋

the cat command is literally the "show me the guts" command. it prints internal objects straight to stdout. that's it, that's the whole vibe. no rewriting, no cleaning up, just raw object energy dumped at your terminal. 🫶

---

💀 EXIT STATUS 💀

here's where it gets real, so pay attention bestie:

• 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 🙈

know these numbers. they will tell you exactly what went wrong and you will not have to guess. periodt.

---

💅 OPTIONS 💅

• -h, --help[=false] — help for cat. your little emergency handbook. ✨

---

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

these are the ones she got from her parent commands, i.e. the restic family genes. all iconic, all important:

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

notice how two of these say (insecure) in them? that is not me being dramatic for the bit. those are genuinely insecure. read before you use. 🚨

---

🌈 SEE ALSO 🌈

• restic(1) — the mothership. go say hi. 💖

---

and that's the whole page, bestie. you ate this. 💅✨

this lil beauty was generated by restic generate and it's been kicking around since Jan 2017 — vintage but still serving, we love a timeless queen 👑🦋