RESTIC-LIST(1)

πŸ’– restic-list(1) β€” aka the restic backup(1) manual, bestie edition πŸ’–

okay so you're here for the list command, and yes the page header says restic backup(1) (iconic little copy-paste moment, we love her, we're keeping her), but the actual star of the show is restic-list. let's go πŸ¦‹


✨ NAME ✨

restic-list β€” List objects in the repository


🌸 SYNOPSIS 🌸

restic list [flags] [blobs|packs|index|snapshots|keys|locks]

πŸ’… DESCRIPTION πŸ’…

The list command allows listing objects in the repository based on type.

that's it. that's the whole vibe. you tell her what kind of thing you wanna see, she shows you the things. lowkey perfect. πŸŽ€


πŸ‘‘ 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.

bestie. write these down. they're literally the group chat receipts of "what went wrong". πŸ”₯

✨ OPTIONS ✨

  • -h, --help[=false] β€” help for list

🫢 OPTIONS INHERITED FROM PARENT COMMANDS 🫢

these are the ones she got from her parent command. nepo baby but make it useful. πŸ’œ

  • --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)
🚨 bestie warning: --insecure-no-password and --insecure-tls are literally labeled (insecure) by the authors themselves. that's not me being dramatic, that's the manpage being dramatic. use with your whole chest only if you know what you're doing. πŸ’€

🌈 SEE ALSO 🌈

restic(1)


that's the whole page, you ate, you're the main character of your own backups πŸ’–

this little love letter was generated by restic generate, dated Jan 2017, and it's serving restic backup(1) energy from start to finish. mwah. πŸŽ€βœ¨πŸ’…

πŸ“¦ where this page comes from