.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "GDAL-VSI-LIST" "1" "May 06, 2025" "" "GDAL"
.SH NAME
gdal-vsi-list \- List files of one of the GDAL Virtual System Interface (VSI)
.sp
Added in version 3.11.

.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
Usage: gdal vsi list [OPTIONS] <FILENAME>

List files of one of the GDAL Virtual System Interface (VSI).

Positional arguments:
  \-\-filename <FILENAME>                                File or directory name [required]

Common Options:
  \-h, \-\-help                                           Display help message and exit
  \-\-json\-usage                                         Display usage as JSON document and exit
  \-\-config <KEY>=<VALUE>                               Configuration option [may be repeated]

Options:
  \-f, \-\-of, \-\-format, \-\-output\-format <OUTPUT\-FORMAT>  Output format. OUTPUT\-FORMAT=json|text (default: json)
  \-l, \-\-long, \-\-long\-listing                           Use a long listing format
  \-R, \-\-recursive                                      List subdirectories recursively
  \-\-depth <DEPTH>                                      Maximum depth in recursive mode
  \-\-abs, \-\-absolute\-path                               Display absolute path
  \-\-tree                                               Use a hierarchical presentation for JSON output
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fBgdal vsi list\fP list files of \fI\%GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...\fP\&.
.sp
This is the equivalent of the UNIX \fBls\fP command, and \fBgdal vsi ls\fP is an
alias for \fBgdal vsi list\fP\&.
.sp
By default, it outputs file names, at the immediate level, without details,
and in JSON format.
.SS Options
.INDENT 0.0
.TP
.B \-\-filename <FILENAME>
Any file name or directory name, of one of the GDAL Virtual file systems.
Required.
.UNINDENT
.INDENT 0.0
.TP
.B \-f, \-\-of, \-\-format, \-\-output\-format json|text
Which output format to use. Default is JSON.
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-long, \-\-long\-listing
Use a long listing format, adding permissions, file size and last modification
date.
.UNINDENT
.INDENT 0.0
.TP
.B \-R, \-\-recursive
List subdirectories recursively. By default the depth is unlimited, but
it can be reduced with \fI\%\-\-depth\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-depth <DEPTH>
Maximum depth in recursive mode. 1 corresponds to no recursion, 2 to
the immediate subdirectories, etc.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-abs, \-\-absolute\-path
Whether to report file names as absolute paths. By default, they are relative
to the input file name.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-tree
Use a hierarchical presentation for JSON output, instead of a flat list.
Only valid when \fI\%\-\-output\-format\fP is set to \fBjson\fP (or let at its default value).
.UNINDENT
.SH EXAMPLES
.SS Example 1: Listing recursively files in /vsis3/bucket with details
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ gdal vsi list \-lR \-\-of=text /vsis3/bucket
.EE
.UNINDENT
.UNINDENT
.SH AUTHOR
Even Rouault <even.rouault@spatialys.com>
.SH COPYRIGHT
1998-2025
.\" Generated by docutils manpage writer.
.