mc ls
The mc ls command lists buckets and objects on an 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 (that is, the bucket and path to the object). For example:
mc ls myaistor/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, mc 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#ssformat. 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 list only 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 list only those object versions which existed at a specific point in time.
--summarize
Optional Display 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
ALIASwith thealiasof the S3-compatible host. -
Replace
PATHwith the path to the bucket on the S3-compatible host.If specifying the path to the S3 root (
ALIASonly), include the--recursiveoption.
List object versions
Use mc ls --versions to list all versions of an object:
mc ls --versions ALIAS/PATH
- Replace
ALIASwith thealiasof the S3-compatible host. - Replace
PATHwith 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
ALIASwith thealiasof the S3-compatible host. - Replace
PATHwith the path to the bucket or object on the S3-compatible host. - Replace
DURATIONwith the point-in-time in the past at which the command returns the object. For example, specify30dto 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.
MinIO 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.