mc ls
The mc ls
command lists buckets and objects on a AIStor deployment.
You can also use mc ls
to list objects on S3-compatible services.
Syntax
Parameters
ALIAS
Required The object or objects to copy.
For listing objects on AIStor, specify the alias and the full path to that object (e.g. bucket and path to object). For example:
mc ls play/mybucket/object.txt
For listing objects on a local filesystem, specify the full path to that object. For example:
mc ls ~/mydata/object.txt
If you specify a directory or bucket to ALIAS
, you must also specify --recursive
to recursively list the contents of that directory or bucket.
If you omit the --recursive
argument, ls
only lists objects in the top level of the specified directory or bucket.
incomplete, -I
Optional Returns any incomplete uploads on the specified ALIAS
bucket.
--recursive
Alias: -r
Optional Recursively lists the contents of each bucket or directory in the ALIAS
.
--rewind
Optional
Directs mc ls
to operate only on the object version(s) that existed at specified point-in-time.
- To rewind to a specific date in the past, specify the date as an ISO8601-formatted timestamp.
For example:
--rewind "2020.03.24T10:00"
. - To rewind a duration in time, specify the duration as a string in
#d#hh#mm#ss
format. For example:--rewind "1d2hh3mm4ss"
.
--rewind
requires that the specified ALIAS
be an S3-compatible service that supports Bucket Versioning.
For AIStor deployments, use mc version
to enable or disable bucket versioning.
Use --rewind
and --versions
together to display on those object versions which existed at a specific point in time.
--versions
Optional
Directs mc ls
to operate on all object versions that exist in the bucket.
--versions
requires that the specified ALIAS
be an S3-compatible service that supports Bucket Versioning.
For AIStor deployments, use mc version
to enable or disable bucket versioning.
Use --versions
and --rewind
together to display on those object versions which existed at a specific point in time.
--summarize
Optional Displays summarized information for the specified ALIAS
path.
Global Flags
This command supports any of the global flags.
Examples
List Bucket Contents
Use mc ls
to list the contents of a bucket:
mc ls [--recursive] ALIAS/PATH
-
Replace
PATH
with the path to the bucket on the S3-compatible host.If specifying the path to the S3 root (
ALIAS
only), include the--recursive
option.
List Object Versions
Use mc ls --versions
to list all versions of an object:
mc ls --versions ALIAS/PATH
- Replace
ALIAS
with thealias
of the S3-compatible host. - Replace
PATH
with the path to the bucket or object on the S3-compatible host.
List Bucket Contents at Point in Time
Use mc ls --versions
to list all versions of an object:
mc ls --rewind DURATION ALIAS/PATH
- Replace
ALIAS
with thealias
of the S3-compatible host. - Replace
PATH
with the path to the bucket or object on the S3-compatible host. - Replace
DURATION
with the point-in-time in the past at which the command returns theobject. For example, specify30d
to return the version of the object 30 days prior to the current date.
Behavior
S3 Compatibility
The mc
commandline tool is built for compatibility with the AWS S3 API and is tested with AIStor and AWS S3 for expected functionality and behavior.
AIStor provides no guarantees for other S3-compatible services, As their S3 API implementation is unknown and therefore unsupported.
While mc
commands may work as documented, any such usage is at your own risk.