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
20       directories of the latest snapshot in the repository. The --host flag
21       can be used in conjunction to select the latest snapshot originating
22       from a 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]
43           help for ls
44
45
46       -H, --host=[]
47           only consider snapshots for this host, when no snapshot ID is given
48       (can be specified multiple times)
49
50
51       -l, --long[=false]
52           use a long listing format showing size and mode
53
54
55       --path=[]
56           only consider snapshots which include this (absolute) path, when no
57       snapshot ID is given
58
59
60       --recursive[=false]
61           include files in subfolders of the listed directories
62
63
64       --tag=[]
65           only consider snapshots which include this taglist, when no
66       snapshot ID is given
67
68
69

OPTIONS INHERITED FROM PARENT COMMANDS

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

NAME

SYNOPSIS

DESCRIPTION

EXIT STATUS

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO