mc ls

The mc ls command lists buckets and objects on a MinIO AIStor deployment.

You can also use mc ls to list objects on S3-compatible services.

Syntax

Example

The following command lists all objects in a bucket on the myaistor deployment:

mc ls myaistor/mybucket/

The output resembles the following:

[2022-11-08 11:30:24 PST]    52MB  STANDARD log-data.csv
[2022-11-09 12:20:18 PST]    120MB STANDARD videos/event-2022-11-09.mp4

Syntax

The mc ls command has the following syntax:

mc [GLOBALFLAGS] ls                \
                 [--incomplete]    \
                 [--recursive]     \
                 [--rewind]        \
                 [--storage-class] \
                 [--versions]      \
                 [--summarize]     \
                 [--zip]           \
                 ALIAS [ALIAS ...]

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS

Required The object or objects to copy.

For listing objects on MinIO 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

Alias: -I

Optional Returns any incomplete uploads on the specified ALIAS bucket.

--incomplete

Alias: -I

Optional Lists incomplete uploads in the ALIAS rather than completed objects.

--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 MinIO 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.

--storage-class

Alias: -sc

Optional Filters the listing to objects in the specified storage class.

--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 MinIO 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.

--zip

Optional

List the files inside a .zip archive instead of listing the archive object itself. MinIO AIStor reads the archive index server-side using the S3 ZIP extension.

--zip requires that the ALIAS path resolve to an archive on a MinIO AIStor deployment. You must specify both the bucket and the archive object, and the archive object key must end in .zip. Listing a bucket with --zip returns an error.

By default, mc ls --zip returns only the top level of the archive, where nested paths appear as directories. Add --recursive to list every file in the archive.

--zip is mutually exclusive with --versions and --rewind. In a versioned bucket, mc ls --zip always reads the latest version of the archive.

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 ALIAS with the alias of the S3-compatible host.
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 the alias 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 the alias 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 the object. For example, specify 30d to return the version of the object 30 days prior to the current date.

List the contents of a ZIP archive

Use mc ls --zip to list the files inside a .zip archive:

mc ls --recursive --zip ALIAS/PATH/ARCHIVE.zip

Replace ALIAS with the alias of the MinIO AIStor deployment.
Replace PATH with the path to the bucket that holds the archive.
Replace ARCHIVE.zip with the name of the archive object.

mc ls lists each file inside the archive with its own size and modification time. Omit --recursive to list only the top level of the archive.

Behavior

S3 compatibility

The mc command-line tool is built for compatibility with the AWS S3 API and is tested with MinIO 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.