mc tree
Syntax
The mc tree
command lists all prefixes inside a MinIO bucket in a tree
format. The command optionally supports listing all objects inside of bucket
at each prefix, including the bucket root.
You can also use mc tree
against a local filesystem directory to
produce similar results to the tree
commandline tool.
The following command prints a complete tree of all objects at any
depth in the mydata
bucket on the myminio
MinIO deployment:
mc tree --files myminio/mydata
The command has the following syntax:
mc [GLOBALFLAGS] tree \
[--depth int] \
[--files] \
[--rewind "string"] \
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 alias of a MinIO deployment and the full path to the bucket to list the tree hierarchy. For example:
mc tree myminio/mybucket
You can specify multiple targets to the
mc tree
command. For example:mc tree myminio/mybucket myminio/myotherbucket
For retrieving the tree heirarchy of a local filesystem directory, specify the full path to that directory. For example:
mc tree ~/minio/mydata/
- --depth, d
Optional Limit the tree depth to the specified integer value.
Defaults to
-1
or unlimited depth.
- --files, f
Optional Includes files in the object or directory in the
mc tree
output.
- --rewind
- Optional
Directs
mc tree
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 specifiedALIAS
be an S3-compatible service that supports Bucket Versioning. For MinIO deployments, usemc version
to enable or disable bucket versioning.
Examples
mc tree ALIAS/PATH
Behavior
S3 Compatibility
The mc commandline tool is built for compatibility with the AWS S3 API and is tested with MinIO 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.