restic-key(1)

1restic backup(1)                                              restic backup(1)
2
3
4

NAME

6       restic-key - Manage keys (passwords)
7
8
9

SYNOPSIS

11       restic key [flags] [list|add|remove|passwd] [ID]
12
13
14

DESCRIPTION

16       The  "key"  command  manages keys (passwords) for accessing the reposi‐
17       tory.
18
19
20

EXIT STATUS

22       Exit status is 0 if the command was successful, and non-zero  if  there
23       was any error.
24
25
26

OPTIONS

28       -h, --help[=false]      help for key
29
30
31       --host=""      the hostname for new keys
32
33
34       --new-password-file=""      file from which to read the new password
35
36
37       --user=""      the username for new keys
38
39
40

OPTIONS INHERITED FROM PARENT COMMANDS

42       --cacert=[]      file to load root certificates from (default: use sys‐
43       tem certificates or $RESTIC_CACERT)
44
45
46       --cache-dir=""      set the cache directory. (default: use  system  de‐
47       fault cache directory)
48
49
50       --cleanup-cache[=false]      auto remove old cache directories
51
52
53       --compression=auto      compression mode (only available for repository
54       format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)
55
56
57       --insecure-tls[=false]      skip TLS certificate verification when con‐
58       necting to the repository (insecure)
59
60
61       --json[=false]       set  output mode to JSON for commands that support
62       it
63
64
65       --key-hint=""      key ID of key  to  try  decrypting  first  (default:
66       $RESTIC_KEY_HINT)
67
68
69       --limit-download=0       limits  downloads  to a maximum rate in KiB/s.
70       (default: unlimited)
71
72
73       --limit-upload=0      limits uploads to a maximum rate in  KiB/s.  (de‐
74       fault: unlimited)
75
76
77       --no-cache[=false]      do not use a local cache
78
79
80       --no-lock[=false]      do not lock the repository, this allows some op‐
81       erations on read-only repositories
82
83
84       -o, --option=[]      set extended option (key=value, can  be  specified
85       multiple times)
86
87
88       --pack-size=0       set target pack size in MiB, created pack files may
89       be larger (default: $RESTIC_PACK_SIZE)
90
91
92       --password-command=""      shell command to obtain the repository pass‐
93       word from (default: $RESTIC_PASSWORD_COMMAND)
94
95
96       -p,  --password-file=""       file to read the repository password from
97       (default: $RESTIC_PASSWORD_FILE)
98
99
100       -q, --quiet[=false]      do not output comprehensive progress report
101
102
103       -r, --repo=""      repository to backup to or  restore  from  (default:
104       $RESTIC_REPOSITORY)
105
106
107       --repository-file=""       file  to  read  the repository location from
108       (default: $RESTIC_REPOSITORY_FILE)
109
110
111       --retry-lock=0s      retry to lock the  repository  if  it  is  already
112       locked, takes a value like 5m or 2h (default: no retries)
113
114
115       --tls-client-cert=""       path  to  a  file containing PEM encoded TLS
116       client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
117
118
119       -v, --verbose[=0]      be verbose (specify multiple times  or  a  level
120       using --verbose=n``, max level/times is 2)
121
122
123

NAME

SYNOPSIS

DESCRIPTION

EXIT STATUS

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO