restic-ls(1)

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

NAME

6       restic-ls - List files in a snapshot
7
8
9

SYNOPSIS

11       restic ls [flags] snapshotID [dir...]
12
13
14

DESCRIPTION

16       The "ls" command lists files and directories in a snapshot.
17
18
19       The special snapshot ID "latest" can be used to list files and directo‐
20       ries of the latest snapshot in the repository. The --host flag  can  be
21       used  in  conjunction  to select the latest snapshot originating from a
22       certain host only.
23
24
25       File listings can optionally be filtered by directories. Any positional
26       arguments  after  the snapshot ID are interpreted as absolute directory
27       paths, and only files inside those directories will be listed.  If  the
28       --recursive  flag  is  used, then the filter will allow traversing into
29       matching directories' subfolders.  Any directory paths  specified  must
30       be  absolute  (starting  with  a path separator); paths use the forward
31       slash '/' as separator.
32
33
34

EXIT STATUS

36       Exit status is 0 if the command was successful, and non-zero  if  there
37       was any error.
38
39
40

OPTIONS

42       -h, --help[=false]      help for ls
43
44
45       -H, --host=[]      only consider snapshots for this host, when no snap‐
46       shot ID is given (can be specified multiple times)
47
48
49       -l, --long[=false]      use a long listing format showing size and mode
50
51
52       --path=[]      only consider snapshots which  include  this  (absolute)
53       path, when no snapshot ID is given
54
55
56       --recursive[=false]       include files in subfolders of the listed di‐
57       rectories
58
59
60       --tag=[]      only consider snapshots which include this taglist,  when
61       no snapshot ID is given
62
63
64

OPTIONS INHERITED FROM PARENT COMMANDS

66       --cacert=[]      file to load root certificates from (default: use sys‐
67       tem certificates)
68
69
70       --cache-dir=""      set the cache directory. (default: use  system  de‐
71       fault cache directory)
72
73
74       --cleanup-cache[=false]      auto remove old cache directories
75
76
77       --json[=false]       set  output mode to JSON for commands that support
78       it
79
80
81       --key-hint=""      key ID of key  to  try  decrypting  first  (default:
82       $RESTIC_KEY_HINT)
83
84
85       --limit-download=0       limits  downloads  to a maximum rate in KiB/s.
86       (default: unlimited)
87
88
89       --limit-upload=0      limits uploads to a maximum rate in  KiB/s.  (de‐
90       fault: unlimited)
91
92
93       --no-cache[=false]      do not use a local cache
94
95
96       --no-lock[=false]      do not lock the repository, this allows some op‐
97       erations on read-only repositories
98
99
100       -o, --option=[]      set extended option (key=value, can  be  specified
101       multiple times)
102
103
104       --password-command=""      shell command to obtain the repository pass‐
105       word from (default: $RESTIC_PASSWORD_COMMAND)
106
107
108       -p, --password-file=""      file to read the repository  password  from
109       (default: $RESTIC_PASSWORD_FILE)
110
111
112       -q, --quiet[=false]      do not output comprehensive progress report
113
114
115       -r,  --repo=""       repository  to backup to or restore from (default:
116       $RESTIC_REPOSITORY)
117
118
119       --repository-file=""      file to read  the  repository  location  from
120       (default: $RESTIC_REPOSITORY_FILE)
121
122
123       --tls-client-cert=""       path  to  a  file containing PEM encoded TLS
124       client certificate and private key
125
126
127       -v, --verbose[=0]      be verbose (specify multiple times  or  a  level
128       using --verbose=n, max level/times is 3)
129
130
131

NAME

SYNOPSIS

DESCRIPTION

EXIT STATUS

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO