RESTIC-KEY-LIST(1)

πŸ“¦
version 0.19.1 Β· 3 versions
, in arch rolling, epel 10, epel 9, fedora 43, fedora 44, nixpkgs unstable, ubuntu stonking

okay bestie, quick housekeeping before we get into it: this page lives in the restic backup(1) manual (yeah, both sides of the header say that, it's a whole thing, we don't question it) and the page itself is restic-key-list(1). now let's GO πŸ’…

🌸 NAME 🌸

restic-key-list β€” list keys (passwords)


πŸ¦‹ SYNOPSIS πŸ¦‹

restic key list [flags]

✨ DESCRIPTION ✨

so the key list command? it lists every single key (password) that's associated with the repository. that's it, that's the vibe. no cap.

and for each one it hands you:

  • the key ID
  • the username
  • the hostname
  • the created time
  • and whether it's the current key being used to access the repository πŸ‘‘

like it's giving full receipts on your keys. obsessed, honestly.


πŸ’€ EXIT STATUS πŸ’€

listen, exit codes are the moment, so pay attention bestie:

  • 0 β€” slayed, the command was successful ✨
  • 1 β€” nope, there was any error 😭
  • 10 β€” the repository does not exist πŸ«₯
  • 11 β€” the repository is already locked πŸ”’
  • 12 β€” the password is incorrect πŸ™ˆ
fr fr, if you're scripting this, check those codes. 1 and 10 and 11 and 12 are all different moods.

πŸŽ€ OPTIONS πŸŽ€

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

πŸ‘‘ OPTIONS INHERITED FROM PARENT COMMANDS πŸ‘‘

these ones come down from the parent commands, so they're the family heirlooms:

  • --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)
heads up bestie: the two insecure ones are literally labeled insecure in the docs, so like… they mean it. πŸ’€

🌈 SEE ALSO 🌈


and that's the whole page, you ate it, no crumbs πŸ’– it was generated by restic generate, dated Jan 2017, and it lives in the restic backup(1) manual. periodt. πŸŽ€βœ¨πŸ¦‹

πŸ“¦ where this page comes from