RESTIC-MOUNT(1)

✨ NAME ✨

restic-mount — mount the repository, bestie 🫶 it's giving "your backups, but as a folder you can just… walk into" 💖

---

🦋 SYNOPSIS 🦋

restic mount [flags] mountpoint

---

🌸 DESCRIPTION 🌸

okay so the mount command literally mounts the repository read-only via FUSE at the given mountpoint. That's it, that's the whole vibe. Read-only, no cap — you're browsing, not editing, so don't come for me if you can't write to it 💅

🎀 Snapshot Directories 🎀

so if the default folders that hold your snapshots aren't giving what you need, you can pass a time template with --time-template and path templates with --path-template. Customize away, icon 👑

example time template without colons:

--time-template "2006-01-02_15-04-05"

and here's the thing: you have to specify a sample format for exactly this timestamp:

Mon Jan 2 15:04:05 -0700 MST 2006

like, exactly that. For the details, please see the documentation for time.Format() at:

https://godoc.org/time#Time.Format

for path templates, these are the patterns you can use and they will get replaced:

• %i → short snapshot ID
• %I → long snapshot ID
• %u → username
• %h → hostname
• %t → tags
• %T → timestamp as specified by --time-template

the default path templates are:

"ids/%i"
"snapshots/%T"
"hosts/%h/%T"
"tags/%t/%T"

---

💀 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 🔑

not me memorizing these… write them down bestie, your shell scripts will thank you 💖

---

✨ OPTIONS ✨

• --allow-other[=false] — let other users access the data in the mounted directory 👀
• -h, --help[=false] — help for mount 🆘
• -H, --host=[] — only consider snapshots for this host (can be specified multiple times, use empty string to unset default value) (default: $RESTIC_HOST) 🖥️
• --no-default-permissions[=false] — for 'allow-other', ignore Unix permissions and allow users to read all snapshot files 🚨
• --owner-root[=false] — use 'root' as the owner of files and dirs 👑
• --path=[] — only consider snapshots including this (absolute) path (can be specified multiple times, snapshots must include all specified paths) 📁
• --path-template=[] — set template for path names (can be specified multiple times) 🎀
• --tag=[] — only consider snapshots including tag[,tag,...] (can be specified multiple times) 🏷️
• --time-template="2006-01-02T15:04:05Z07:00" — set template to use for times ⏰

---

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these ones come from the parent command, they're the whole restic family's shared slay 💜

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

lowkey obsessed with -v — hit it twice max, that's the ceiling bestie, level 2 and done 🔥

---

🫶 SEE ALSO 🫶

• restic(1)

---

and that's the whole page, periodt 💅 this one was generated by restic generate, dated Jan 2017 — she's an icon, she's a legend, and she is the moment 🌟