RESTIC-TAG(1)

πŸ’– restic-tag β€” a manual page for the restic backup(1) bestie era πŸ’–

okay so hi. this is restic-tag, part of the restic backup(1) manual. yes the header says "backup" and the command is "tag", that's just how the manual family rolls, we don't question it, we accept it, we move on. 🫢


✨ NAME ✨

restic-tag β€” modify tags on snapshots πŸ’…


✨ SYNOPSIS ✨

restic tag [flags] [snapshotID ...]

✨ DESCRIPTION ✨

The tag command lets you modify tags on existing snapshots. like, the tags are already out there living their life, and you can go in and change them. iconique.

You have two whole vibes to choose from:

  • set/replace the entire set of tags on a snapshot (scorched earth, new era πŸ’…)
  • add tags to / remove tags from the existing set (gentle little edits, no drama πŸ¦‹)

And here's the cute part: when no snapshotID is given, all snapshots matching the host, tag and path filter criteria are modified. so you can tag a whole squad at once. main character energy fr fr.

⚠️ heads up bestie: no snapshotID means the filters decide everything. know your --host, --tag and --path before you go in swinging. 😭

✨ EXIT STATUS ✨

  • 0 β€” slay, the command was successful πŸ’–
  • 1 β€” there was any error 😭
  • 10 β€” the repository does not exist
  • 11 β€” the repository is already locked πŸ”’
  • 12 β€” the password is incorrect πŸ™ˆ

✨ OPTIONS ✨

  • --add=[] β€” tags which will be added to the existing tags in the format tag[,tag,...] (can be given multiple times) ✨
  • -h, --help[=false] β€” help for tag πŸ₯Ί
  • -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)
  • --remove=[] β€” tags which will be removed from the existing tags in the format tag[,tag,...] (can be given multiple times) πŸ’€
  • --set=[] β€” tags which will replace the existing tags in the format tag[,tag,...] (can be given multiple times) πŸ‘‘
  • --tag=[] β€” only consider snapshots including tag[,tag,...] (can be specified multiple times)

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these ones are the family hand-me-downs, they come from the parent command and they're iconic:

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


okay that's the whole page, you ate that bestie πŸ’… go forth and tag responsibly. no cap. πŸ¦‹βœ¨

sign-off time: this lil masterpiece was generated by restic generate, dated Jan 2017, and it's the restic backup(1) manual in the house. periodt. πŸ‘‘πŸ’–

πŸ“¦ where this page comes from