MinIO Client (mc) provides a modern alternative to UNIX commands like ls, cat, cp, mirror, diff etc. It supports filesystems and Amazon S3 compatible cloud storage service (AWS Signature v2 and v4).
alias set, remove and list aliases in configuration file
ls list buckets and objects
mb make a bucket
rb remove a bucket
cp copy objects
mirror synchronize object(s) to a remote site
cat display object contents
head display first 'n' lines of an object
pipe stream STDIN to an object
share generate URL for temporary access to an object
find search for objects
sql run sql queries on objects
stat show object metadata
mv move objects
tree list buckets and objects in a tree format
du summarize disk usage recursively
retention set retention for object(s) and bucket(s)
legalhold set legal hold for object(s)
diff list differences in object name, size, and date between two buckets
rm remove objects
version manage bucket versioning
ilm manage bucket lifecycle
encrypt manage bucket encryption config
event manage object notifications
watch listen for object notification events
undo undo PUT/DELETE operations
policy manage anonymous access to buckets and objects
tag manage tags for bucket(s) and object(s)
replicate configure server side bucket replication
admin manage MinIO servers
update update mc to latest release
support supportability tools like profile, register, callhome, inspect
ping perform liveness check
docker pull minio/mc
docker run minio/mc ls play
docker pull minio/mc:edge
docker run minio/mc:edge ls play
Note: Above examples run mc against MinIO play environment by default. To run mc against other S3 compatible servers, start the container this way:
docker run -it --entrypoint=/bin/sh minio/mc
then use the mc alias command.
Install mc packages using Homebrew
brew install minio/stable/mc
mc --help
| Platform | Architecture | URL |
|---|---|---|
| GNU/Linux | 64-bit Intel | https://dl.min.io/client/mc/release/linux-amd64/mc |
| 64-bit PPC | https://dl.min.io/client/mc/release/linux-ppc64le/mc |
chmod +x mc
./mc --help
| Platform | Architecture | URL |
|---|---|---|
| Microsoft Windows | 64-bit Intel | https://dl.min.io/client/mc/release/windows-amd64/mc.exe |
mc.exe --help
Source installation is intended only for developers and advanced users. mc update command does not support update notifications for source based installations. Please download official releases from https://min.io/download/#minio-client.
If you do not have a working Golang environment, please follow How to install Golang.
go get -d github.com/minio/mc
cd ${GOPATH}/src/github.com/minio/mc
make
chmod +x mc
./mc --help
chmod 755 mc
./mc --help
mc.exe --help
Note: If you are planning to use mc only on POSIX compatible filesystems, you may skip this step and proceed to Step 4.
To add one or more Amazon S3 compatible hosts, please follow the instructions below. mc stores all its configuration information in ~/.mc/config.json file.
mc alias set <ALIAS> <YOUR-S3-ENDPOINT> [YOUR-ACCESS-KEY] [YOUR-SECRET-KEY] [--api API-SIGNATURE]
Keys must be supplied by argument or standard input.
Alias is simply a short name to your cloud storage service. S3 end-point, access and secret keys are supplied by your cloud storage provider. API signature is an optional argument. By default, it is set to "S3v4".
MinIO server displays URL, access and secret keys.
mc alias set minio http://192.168.1.51 BKIKJAA5BMMU2RHO6IBB V7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12 --api S3v4
Get your AccessKeyID and SecretAccessKey by following AWS Credentials Guide.
mc alias set s3 https://s3.amazonaws.com BKIKJAA5BMMU2RHO6IBB V7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12 --api S3v4
Get your AccessKeyID and SecretAccessKey by following Google Credentials Guide
mc alias set gcs https://storage.googleapis.com BKIKJAA5BMMU2RHO6IBB V8f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12
Get your AccessKeyID and SecretAccessKey by creating a service account with HMAC credentials. This option is only available from Resources > Cloud Object Storage > Service credentials (not from Manage > Access (IAM) > Service IDs). Once created, the values you will use for accessKey and secretKey are found in the cos_hmac_keys field of the service credentials.
Finally, the url will be the public endpoint specific to the region/resiliency that you chose when setting up your bucket. There is no single, global url for all buckets. Find your bucket's URL in the console by going to Cloud Object Storage > Buckets > [your-bucket] > Configuration > Endpoints > public. Remember to prepend https:// to the URL provided.
mc alias set ibm https://s3.us-east.cloud-object-storage.appdomain.cloud BKIKJAA5BMMU2RHO6IBB V8f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12 --api s3v4
Note: The service ID you create must have an access policy granting it access to your Object Storage instance(s).
mc alias set minio http://192.168.1.51 --api S3v4
Enter Access Key: BKIKJAA5BMMU2RHO6IBB
Enter Secret Key: V7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12
echo -e "BKIKJAA5BMMU2RHO6IBB\nV7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12" | \
mc alias set minio http://192.168.1.51 --api S3v4
export MC_HOST_<alias>=https://<Access Key>:<Secret Key>@<YOUR-S3-ENDPOINT>
Example:
export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:[email protected]
mc ls myalias
export MC_HOST_<alias>=https://<Access Key>:<Secret Key>:<Session Token>@<YOUR-S3-ENDPOINT>
Example:
export MC_HOST_myalias=https://Q3AM3UQ867SPQQA43P2F:zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG:eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NLZXkiOiJOVUlCT1JaWVRWMkhHMkJNUlNYUiIsImF1ZCI6IlBvRWdYUDZ1Vk80NUlzRU5SbmdEWGo1QXU1WWEiLCJhenAiOiJQb0VnWFA2dVZPNDVJc0VOUm5nRFhqNUF1NVlhIiwiZXhwIjoxNTM0ODk2NjI5LCJpYXQiOjE1MzQ4OTMwMjksImlzcyI6Imh0dHBzOi8vbG9jYWxob3N0Ojk0NDMvb2F1dGgyL3Rva2VuIiwianRpIjoiNjY2OTZjZTctN2U1Ny00ZjU5LWI0MWQtM2E1YTMzZGZiNjA4In0.eJONnVaSVHypiXKEARSMnSKgr-2mlC2Sr4fEGJitLcJF_at3LeNdTHv0_oHsv6ZZA3zueVGgFlVXMlREgr9LXA@play.min.io
mc ls myalias
mc is pre-configured with https://play.min.io, aliased as "play". It is a hosted MinIO server for testing and development purpose. To test Amazon S3, simply replace "play" with "s3" or the alias you used at the time of setup.
Example:
List all buckets from https://play.min.io
mc ls play
[2016-03-22 19:47:48 PDT] 0B my-bucketname/
[2016-03-22 22:01:07 PDT] 0B mytestbucket/
[2016-03-22 20:04:39 PDT] 0B mybucketname/
[2016-01-28 17:23:11 PST] 0B newbucket/
[2016-03-20 09:08:36 PDT] 0B s3git-test/
You may add shell aliases to override your common Unix tools.
alias ls='mc ls'
alias cp='mc cp'
alias cat='mc cat'
alias mkdir='mc mb'
alias pipe='mc pipe'
alias find='mc find'
alias tree='mc tree'
Install auto-completion for your shell.
Debug option enables debug output to console.
Example: Display verbose debug output for ls command.
mc --debug ls play
mc: <DEBUG> GET / HTTP/1.1
Host: play.min.io
User-Agent: MinIO (darwin; amd64) minio-go/1.0.1 mc/2016-04-01T00:22:11Z
Authorization: AWS4-HMAC-SHA256 Credential=**REDACTED**/20160408/us-east-1/s3/aws4_request, SignedHeaders=expect;host;x-amz-content-sha256;x-amz-date, Signature=**REDACTED**
Expect: 100-continue
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
X-Amz-Date: 20160408T145236Z
Accept-Encoding: gzip
mc: <DEBUG> HTTP/1.1 200 OK
Transfer-Encoding: chunked
Accept-Ranges: bytes
Content-Type: text/xml; charset=utf-8
Date: Fri, 08 Apr 2016 14:54:55 GMT
Server: MinIO/DEVELOPMENT.2016-04-07T18-53-27Z (linux; amd64)
Vary: Origin
X-Amz-Request-Id: HP30I0W2U49BDBIO
mc: <DEBUG> Response Time: 1.220112837s
[...]
[2016-04-08 03:56:14 IST] 0B albums/
[2016-04-04 16:11:45 IST] 0B backup/
[2016-04-01 20:10:53 IST] 0B deebucket/
[2016-03-28 21:53:49 IST] 0B guestbucket/
JSON option enables parseable output in JSON lines, also called as NDJSON format.
Example: List all buckets from MinIO play service.
mc --json ls play
{"status":"success","type":"folder","lastModified":"2016-04-08T03:56:14.577+05:30","size":0,"key":"albums/"}
{"status":"success","type":"folder","lastModified":"2016-04-04T16:11:45.349+05:30","size":0,"key":"backup/"}
{"status":"success","type":"folder","lastModified":"2016-04-01T20:10:53.941+05:30","size":0,"key":"deebucket/"}
{"status":"success","type":"folder","lastModified":"2016-03-28T21:53:49.217+05:30","size":0,"key":"guestbucket/"}
This option disables the color theme. It is useful for dumb terminals.
Quiet option suppress chatty console output.
Use this option to set a custom config path.
Skip SSL certificate verification.
Display the current version of mc installed
Example: Print version of mc.
mc --version
mc version RELEASE.2020-04-25T00-43-23Z
ls command lists files, buckets and objects. Use --incomplete flag to list partially copied content.
USAGE:
mc ls [FLAGS] TARGET [TARGET ...]
FLAGS:
--rewind value list all object versions no later than specified date
--versions list all versions
--recursive, -r list recursively
--incomplete, -I list incomplete uploads
--help, -h show help
Example: List all buckets on https://play.min.io.
mc ls play
[2016-04-08 03:56:14 IST] 0B albums/
[2016-04-04 16:11:45 IST] 0B backup/
[2016-04-01 20:10:53 IST] 0B deebucket/
[2016-03-28 21:53:49 IST] 0B guestbucket/
[2016-04-08 20:58:18 IST] 0B mybucket/
Example: List all contents versions if the bucket versioning is enabled
mc ls --versions s3/mybucket
[2020-09-21 16:25:31 CET] 903KiB UiL4wSZS2OkST5aJ3AFAwtzZxHTW_9VC v1 PUT foo
[2020-09-18 21:18:44 CET] 0B sK4pldVmOJqCJzX2aJvxX4eWMnuqazs9 v1 DEL bar
Example: List contents created earlier than 3 days
mc ls --rewind 3d s3/mybucket
[2020-09-18 21:18:44 CET] 0B sK4pldVmOJqCJzX2aJvxX4eWMnuqazs9 v1 DEL bar
tree command lists buckets and directories in a tree format. Use --files flag to include files/objects in listing.
USAGE:
mc tree [FLAGS] TARGET [TARGET ...]
FLAGS:
--help, -h show help
--files, -f include files in tree
--depth, -d set the maximum depth of the tree
--rewind value display tree no later than specified dateExample: List all contents on play/test-bucket in a tree format.
mc tree play/test-bucket
play/test-bucket/
├─ dir_a
├─ dir_b
│ └─ dir_bb
└─ dir_x
└─ dir_xxExample: List all objects with the state of 3 days earlier
mc tree --files --rewind 3d play/test-bucket
play/test-bucket/
├─ object1
└─ object2mb command creates a new bucket on an object storage. On a filesystem, it behaves like mkdir -p command. Bucket is equivalent of a drive or mount point in filesystems and should not be treated as folders. MinIO does not place any limits on the number of buckets created per user.
On Amazon S3, each account is limited to 100 buckets. Please refer to Buckets Restrictions and Limitations on S3 for more information.
USAGE:
mc mb [FLAGS] TARGET [TARGET...]
FLAGS:
--region value specify bucket region; defaults to 'us-east-1' (default: "us-east-1")
--ignore-existing, -p ignore if bucket/directory already exists
--with-lock, -l enable object lock
--help, -h show help
Example: Create a new bucket named "mybucket" on https://play.min.io.
mc mb play/mybucket
Bucket created successfully ‘play/mybucket’.
Example: Create a new bucket named "mybucket" on https://s3.amazonaws.com.
mc mb s3/mybucket --region=us-west-1
Bucket created successfully ‘s3/mybucket’.
rb command removes a bucket and all its contents on an object storage. On a filesystem, it behaves like rmdir command.
NOTE: When a bucket is removed all bucket configurations associated with the bucket will also be removed. All objects and their versions will be removed as well. If you need to preserve bucket and its configuration - only empty the objects and versions in a bucket use
mc rminstead.
USAGE:
mc rb [FLAGS] TARGET [TARGET...]
FLAGS:
--force force a recursive remove operation on all object versions
--dangerous allow site-wide removal of objects
--help, -h show help
Example: Remove a bucket named "mybucket" on https://play.min.io.
mc rb play/mybucket --force
Bucket removed successfully ‘play/mybucket’.
du command summarizes disk usage recursively
USAGE:
mc du [FLAGS] TARGET
FLAGS:
--depth value, -d value print the total for a folder prefix only if it is N or fewer levels below the command line argument (default: 0)
--recursive, -r recursively print the total for a folder prefix
--rewind value include all object versions no later than specified date
--versions include all object versions
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
Example: Summarize disk usage of 'jazz-songs' bucket recursively.
mc du s3/jazz-songs
Example: Summarize disk usage of 'jazz-songs' bucket with all objects versions
mc du --versions s3/jazz-songs/
cat command concatenates contents of a file or object to another. You may also use it to simply display the contents to stdout
USAGE:
mc cat [FLAGS] SOURCE [SOURCE...]
FLAGS:
--rewind value display an earlier object version
--version-id value, --vid value display a specific version of an object
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
Example: Display the contents of a text file myobject.txt
mc cat play/mybucket/myobject.txt
Hello MinIO!!
Example: Display the contents of a server encrypted object myencryptedobject.txt
mc cat --encrypt-key "play/mybucket=32byteslongsecretkeymustbegiven1" play/mybucket/myencryptedobject.txt
Hello MinIO!!
Example: Display the contents of a server encrypted object myencryptedobject.txt. Pass base64 encoded string if encryption key contains non-printable character like tab
mc cat --encrypt-key "play/mybucket=MzJieXRlc2xvbmdzZWNyZWFiY2RlZmcJZ2l2ZW5uMjE=" play/mybucket/myencryptedobject.txt
Hello MinIO!!
Example: Display the content of an object 10 days earlier
mc cat --rewind "10d" play/mybucket/myobject
Hello MinIO ten days earlier!
Example: Display the content of an object at a specific date/time in the past
mc cat --rewind "2020.03.24T10:00" play/mybucket/myobject
Hello MinIO from the past!
sql run sql queries on objects.
USAGE:
mc sql [FLAGS] TARGET [TARGET...]
FLAGS:
--query value, -e value sql query expression
--recursive, -r sql query recursively
--csv-input value csv input serialization option
--json-input value json input serialization option
--compression value input compression type
--csv-output value csv output serialization option
--json-output value json output serialization option
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
INPUT SERIALIZATION
--csv-input or --json-input can be used to specify input data format. Format is
specified by a string with pattern "key=value,..." for valid key(s).
DATA FORMAT:
csv: Use --csv-input flag
Valid keys:
RecordDelimiter (rd)
FieldDelimiter (fd)
QuoteChar (qc)
QuoteEscChar (qec)
FileHeader (fh)
Comments (cc)
QuotedRecordDelimiter (qrd)
json: Use --json-input flag
Valid keys:
Type
parquet: If object name ends in .parquet, this is automatically interpreted.
OUTPUT SERIALIZATION
--csv-output or --json-output can be used to specify output data format. Format is
specified by a string with pattern "key=value,..." for valid key(s).
DATA FORMAT:
csv: Use --csv-output flag
Valid keys:
RecordDelimiter (rd)
FieldDelimiter (fd)
QuoteChar (qc)
QuoteEscChar (qec)
QuoteFields (qf)
json: Use --json-output flag
Valid keys:
RecordDelimiter (rd)
COMPRESSION TYPE
--compression specifies if the queried object is compressed.
Valid values: NONE | GZIP | BZIP2
Example: Select all columns on a set of objects recursively on AWS S3
mc sql --recursive --query "select * from S3Object" s3/personalbucket/my-large-csvs/
Example: Run an aggregation query on an object on MinIO
mc sql --query "select count(s.power) from S3Object" myminio/iot-devices/power-ratio.csv
Example: Run an aggregation query on an encrypted object with customer provided keys
mc sql --encrypt-key "myminio/iot-devices=32byteslongsecretkeymustbegiven1" \
--query "select count(s.power) from S3Object" myminio/iot-devices/power-ratio-encrypted.csv
For more query examples refer to official AWS S3 documentation here
head display first 'n' lines of an object
USAGE:
mc head [FLAGS] SOURCE [SOURCE...]
FLAGS:
-n value, --lines value print the first 'n' lines (default: 10)
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
Example: Display the first line of a text file myobject.txt
mc head -n 1 play/mybucket/myobject.txt
Hello!!
Example: Display the first line of a server encrypted object myencryptedobject.txt
mc head -n 1 --encrypt-key "play/mybucket=32byteslongsecretkeymustbegiven1" play/mybucket/myencryptedobject.txt
Hello!!
Example: Display the first line of the content of an object, 1 year earlier
mc head -n 1 --rewind 365d play/mybucket/myencryptedobject.txt
Hello!!
lock sets and gets object lock configuration
RELEASE.2020-09-18T00-13-21Zdeprecates and removes thelockcommand. The retention command fully replaceslockfunctionality.
retention sets object retention for objects with a given prefix or the default
retention settings for a bucket.
USAGE:
mc retention COMMAND [FLAGS | -h] [ARGUMENTS...]
COMMANDS:
set Sets retention for object(s) or bucket
clear Clears retention for object(s) or bucket
info Returns retention for object(s) or bucket
help, h Shows a list of commands or help for one command
FLAGS:
--bypass bypass governance
--recursive, -r apply retention recursively
--json enable JSON formatted output
--help, -h show help
Example: Set governance for 30 days for object prefix on bucket mybucket
mc retention set governance 30d myminio/mybucket/prefix -r
Object retention successfully set for objects with prefix `myminio/mybucket/prefix`.
Objects created with prefix prefix in the above bucket mybucket cannot be deleted until the compliance period is over
mc cp ~/comp.csv myminio/mybucket/prefix/
mc rm myminio/mybucket/prefix/comp.csv
Removing `myminio/mybucket/prefix/comp.csv`.
This creates delete marker (soft delete) you will be able to check if your objects still exist with
mc ls --versions myminio/mybucket/prefix/comp.csv
Example: Set compliance for 30 days as default retention setting on bucket mybucket
mc retention set --default compliance 30d myminio/mybucket
Objects created in the above bucket mybucket cannot be deleted until the compliance period is over
mc cp ~/comp.csv myminio/mybucket/data.csv
mc rm myminio/mybucket/data.csv
Removing `myminio/mybucket/data.csv
This creates delete marker (soft delete) you will be able to check if your objects still exist with
mc ls --versions myminio/mybucket/prefix/data.csv
Example: Clear object retention for a specific version of a specific object
mc retention clear myminio/mybucket/prefix/obj.csv --version-id "3Jr2x6fqlBUsVzbvPihBO3HgNpgZgAnp"
Example: Show object retention for recursively for all versions of all objects under prefix
mc retention info myminio/mybucket/prefix --recursive --versions
legalhold sets object legal hold for objects
USAGE:
mc legalhold COMMAND [FLAGS | -h] TARGET
COMMANDS:
set set legal hold for object(s)
clear clear legal hold for object(s)
info show legal hold info for object(s)
help, h Shows a list of commands or help for one command
FLAGS:
--recursive, -r apply legal hold recursively
--json enable JSON formatted output
--help, -h show help
Example: Enable legal hold for objects with prefix prefix on bucket mybucket
mc legalhold set myminio/mybucket/prefix -r
Object legal hold successfully set for prefix `myminio/mybucket/prefix`.
Objects created with prefix prefix in the above bucket mybucket cannot be deleted until the legal hold is lifted
mc cp ~/test.csv myminio/mybucket/prefix/
mc rm myminio/mybucket/prefix/test.csv
Removing `myminio/mybucket/prefix/test.csv`.
This creates delete marker (soft delete) you will be able to check if your objects still exist with
mc ls --versions myminio/mybucket/prefix/comp.csv
Example: Disable legal hold on a specific object version
mc legalhold clear myminio/mybucket/prefix/obj.csv --version-id "HiMFUTOowG6ylfNi4LKxD3ieHbgfgrvC"
Example: Show object legal hold recursively for all objects at a prefix
mc legalhold info myminio/mybucket/prefix --recursive
pipe command copies contents of stdin to a target. When no target is specified, it writes to stdout.
USAGE:
mc pipe [FLAGS] [TARGET]
FLAGS:
--encrypt value encrypt objects (using server-side encryption with server managed keys)
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT: list of comma delimited prefix values
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
Example: Stream MySQL database dump to Amazon S3 directly.
mysqldump -u root -p ******* accountsdb | mc pipe s3/sql-backups/backups/accountsdb-oct-9-2015.sql
cp command copies data from one or more sources to a target. All copy operations to object storage are verified with MD5SUM checksums. Interrupted or failed copy operations can be resumed from the point of failure.
USAGE:
mc cp [FLAGS] SOURCE [SOURCE...] TARGET
FLAGS:
--rewind value roll back object(s) to current version at specified time
--version-id value, --vid value select an object version to copy
--recursive, -r copy recursively
--older-than value copy object(s) older than value in duration string (e.g. 7d10h31s)
--newer-than value copy object(s) newer than value in duration string (e.g. 7d10h31s)
--storage-class value, --sc value set storage class for new object(s) on target
--preserve,-a preserve file system attributes and bucket policy rules on target bucket(s)
--attr add custom metadata for the object (format: KeyName1=string;KeyName2=string)
--continue, -c create or resume copy session
--encrypt value encrypt/decrypt objects (using server-side encryption with server managed keys)
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--tags value apply tags to the uploaded objects (eg. key=value&key2=value2, etc)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT: list of comma delimited prefixes
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
Example: Copy a text file to an object storage.
mc cp myobject.txt play/mybucket
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Example: Copy a text file to an object storage with specified metadata.
mc cp --attr key1=value1;key2=value2 myobject.txt play/mybucket
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Example: Copy a folder recursively from MinIO cloud storage to Amazon S3 cloud storage with specified metadata.
mc cp --attr Cache-Control=max-age=90000,min-fresh=9000\;key1=value1\;key2=value2 --recursive play/mybucket/burningman2011/ s3/mybucket/
https://play.minio.io:9000/mybucket/myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Example: Copy a text file to an object storage and assign storage-class REDUCED_REDUNDANCY to the uploaded object.
mc cp --storage-class REDUCED_REDUNDANCY myobject.txt play/mybucket
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Example: Copy a server-side encrypted file to an object storage.
mc cp --recursive --encrypt-key "s3/documents/=32byteslongsecretkeymustbegiven1 , myminio/documents/=32byteslongsecretkeymustbegiven2" s3/documents/myobject.txt myminio/documents/
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Example: Perform key-rotation on a server-side encrypted object
mc cp --encrypt-key 'myminio1/mybucket=32byteslongsecretkeymustgenerate , myminio2/mybucket/=32byteslongsecretkeymustgenerat1' myminio1/mybucket/encryptedobject myminio2/mybucket/encryptedobject
encryptedobject: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Notice that two different aliases myminio1 and myminio2 are used for the same endpoint to provide the old secretkey and the newly rotated key.
Example: Copy a javascript file to object storage and assign Cache-Control header to the uploaded object
mc cp --attr Cache-Control=no-cache myscript.js play/mybucket
myscript.js: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0Example: Copy a text file to an object storage and preserve the filesyatem attributes.
mc cp -a myobject.txt play/mybucket
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Example: Roll back to object version to 10 days earlier while copying.
mc cp --rewind 10d play/mybucket/myobject.txt myobject.txt
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
mv command moves data from one or more sources to a target. All move operations to object storage are verified with MD5SUM checksums. Interrupted or failed move operations can be resumed from the point of failure.
USAGE:
mc mv [FLAGS] SOURCE [SOURCE...] TARGET
FLAGS:
--recursive, -r move recursively
--older-than value move object(s) older than value in duration string (e.g. 7d10h31s)
--newer-than value move object(s) newer than value in duration string (e.g. 7d10h31s)
--storage-class value, --sc value set storage class for new object(s) on target
--preserve,-a preserve file system attributes and bucket policy rules on target bucket(s)
--attr add custom metadata for the object (format: KeyName1=string;KeyName2=string)
--continue, -c create or resume move session
--encrypt value encrypt/decrypt objects (using server-side encryption with server managed keys)
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT: list of comma delimited prefixes
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
Example: Move a text file to an object storage.
mc mv myobject.txt play/mybucket
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Waiting move operations to complete
Example: Move a text file to an object storage with specified metadata.
mc mv --attr key1=value1;key2=value2 myobject.txt play/mybucket
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Waiting move operations to complete
Example: Move a folder recursively from MinIO cloud storage to Amazon S3 cloud storage with specified metadata.
mc mv --attr Cache-Control=max-age=90000,min-fresh=9000\;key1=value1\;key2=value2 --recursive play/mybucket/burningman2011/ s3/mybucket/
https://play.minio.io:9000/mybucket/myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Waiting move operations to complete
Example: Move a text file to an object storage and assign storage-class REDUCED_REDUNDANCY to the uploaded object.
mc mv --storage-class REDUCED_REDUNDANCY myobject.txt play/mybucket
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Waiting move operations to complete
Example: Move a server-side encrypted file to an object storage.
mc mv --recursive --encrypt-key "s3/documents/=32byteslongsecretkeymustbegiven1 , myminio/documents/=32byteslongsecretkeymustbegiven2" s3/documents/myobject.txt myminio/documents/
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Waiting move operations to complete
Example: Perform key-rotation on a server-side encrypted object
mc mv --encrypt-key 'myminio1/mybucket=32byteslongsecretkeymustgenerate , myminio2/mybucket/=32byteslongsecretkeymustgenerat1' myminio1/mybucket/encryptedobject myminio2/mybucket/encryptedobject
encryptedobject: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Waiting move operations to complete
Notice that two different aliases myminio1 and myminio2 are used for the same endpoint to provide the old secretkey and the newly rotated key.
Example: Move a javascript file to object storage and assign Cache-Control header to the uploaded object
mc mv --attr Cache-Control=no-cache myscript.js play/mybucket
myscript.js: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Waiting move operations to completeExample: Move a text file to an object storage and preserve the filesyatem attributes.
mc mv -a myobject.txt play/mybucket
myobject.txt: 14 B / 14 B ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100.00 % 41 B/s 0
Waiting move operations to complete
Use rm command to remove file or object
USAGE:
mc rm [FLAGS] TARGET [TARGET ...]
FLAGS:
--versions remove object(s) and all its versions
--rewind value roll back object(s) to current versions at specified time
--version-id value, --vid value delete a specific version of an object
--recursive, -r remove recursively
--force allow a recursive remove operation
--dangerous allow site-wide removal of objects
--incomplete, -I remove incomplete uploads
--dry-run perform a fake remove operation
--stdin read object names from STDIN
--older-than value remove objects older than value in duration string (e.g. 7d10h31s)
--newer-than value remove objects newer than value in duration string (e.g. 7d10h31s)
--bypass bypass governance
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
Example: Remove a single object.
mc rm play/mybucket/myobject.txt
Removing `play/mybucket/myobject.txt`.
Example: Remove an encrypted object.
mc rm --encrypt-key "play/mybucket=32byteslongsecretkeymustbegiven1" play/mybucket/myobject.txt
Removing `play/mybucket/myobject.txt`.
Example: Recursively remove a bucket's contents. Since this is a dangerous operation, you must explicitly pass --force option.
mc rm --recursive --force play/mybucket
Removing `play/mybucket/newfile.txt`.
Removing `play/mybucket/otherobject.txt`.
Example: Remove all uploaded incomplete files for an object.
mc rm --incomplete play/mybucket/myobject.1gig
Removing `play/mybucket/myobject.1gig`.
Example: Remove object and output a message only if the object is created older than 1 day, 2 hours and 30 minutes. Otherwise, the command stays quiet and nothing is printed out.
mc rm -r --force --older-than 1d2h30m myminio/mybucket
Removing `myminio/mybucket/dayOld1.txt`.
Removing `myminio/mybucket/dayOld2.txt`.
Removing `myminio/mybucket/dayOld3.txt`.
Example: Remove a particular version ID.
mc rm myminio/docs/money.xls --version-id "f20f3792-4bd4-4288-8d3c-b9d05b3b62f6"
Removing `myminio/docs/money.xls` (versionId=f20f3792-4bd4-4288-8d3c-b9d05b3b62f6).
Example: Remove all object versions older than one year.
mc rm myminio/docs/ --recursive --versions --rewind 365d
Removing `myminio/docs/foo.xls` (versionId=4d184091-ca84-4730-8d73-9e51a1016dc2, modTime=2019-08-05 13:42:08 +0000 UTC).
Removing `myminio/docs/foo.xls` (versionId=9f716132-81ad-480b-a315-e44144b252a0, modTime=2019-08-05 13:41:59 +0000 UTC).
share command securely grants upload or download access to object storage. This access is only temporary and it is safe to share with remote users and applications. If you want to grant permanent access, you may look at mc policy command instead.
Generated URL has access credentials encoded in it. Any attempt to tamper the URL will invalidate the access. To understand how this mechanism works, please follow Pre-Signed URL technique.
USAGE:
mc share [FLAGS] COMMAND
FLAGS:
--help, -h show help
COMMANDS:
download generate URLs for download access
upload generate ‘curl’ command to upload objects without requiring access/secret keys
list list previously shared objects and folders
share download command generates URLs to download objects without requiring access and secret keys. Expiry option sets the maximum validity period (no more than 7 days), beyond which the access is revoked automatically.
USAGE:
mc share download [FLAGS] TARGET [TARGET...]
FLAGS:
--version-id value, --vid value share a particular object version
--recursive, -r share all objects recursively
--expire value, -E value set expiry in NN[h|m|s] (default: "168h")
--help, -h show help
Example: Grant temporary access to an object with 4 hours expiry limit.
mc share download --expire 4h play/mybucket/myobject.txt
URL: https://play.min.io/mybucket/myobject.txt
Expire: 0 days 4 hours 0 minutes 0 seconds
Share: https://play.min.io/mybucket/myobject.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=Q3AM3UQ867SPQQA43P2F%2F20160408%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20160408T182008Z&X-Amz-Expires=14400&X-Amz-SignedHeaders=host&X-Amz-Signature=1527fc8f21a3a7e39ce3c456907a10b389125047adc552bcd86630b9d459b634
Example: Share a particular version of an object
mc share download --version-id 3Jr2x6fqlBUsVzbvPihBO3HgNpgZgAnp play/mybucket/myobject.txt
URL: https://play.min.io/mybucket/myobject.txt
Expire: 7 days 0 hours 0 minutes 0 seconds
Share: https://play.min.io/mybucket/myobject.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=Q3AM3UQ867SPQQA43P2F%2F20160408%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20160408T182008Z&X-Amz-Expires=604800&versionId=3Jr2x6fqlBUsVzbvPihBO3HgNpgZgAnp&X-Amz-SignedHeaders=host&X-Amz-Signature=1527fc8f21a3a7e39ce3c456907a10b389125047adc552bcd86630b9d459b634
share upload command generates a ‘curl’ command to upload objects without requiring access/secret keys. Expiry option sets the maximum validity period (no more than 7 days), beyond which the access is revoked automatically. Content-type option restricts uploads to only certain type of files.
USAGE:
mc share upload [FLAGS] TARGET [TARGET...]
FLAGS:
--recursive, -r recursively upload any object matching the prefix
--expire value, -E value set expiry in NN[h|m|s] (default: "168h")
--content-type value, -T value specify a content-type to allow
--help, -h show help
Example: Generate a curl command to enable upload access to play/mybucket/myotherobject.txt. User replaces <FILE> with the actual filename to upload
mc share upload play/mybucket/myotherobject.txt
URL: https://play.min.io/mybucket/myotherobject.txt
Expire: 7 days 0 hours 0 minutes 0 seconds
Share: curl https://play.min.io/mybucket -F x-amz-date=20160408T182356Z -F x-amz-signature=de343934bd0ba38bda0903813b5738f23dde67b4065ea2ec2e4e52f6389e51e1 -F bucket=mybucket -F policy=eyJleHBpcmF0aW9uIjoiMjAxNi0wNC0xNVQxODoyMzo1NS4wMDdaIiwiY29uZGl0aW9ucyI6W1siZXEiLCIkYnVja2V0IiwibXlidWNrZXQiXSxbImVxIiwiJGtleSIsIm15b3RoZXJvYmplY3QudHh0Il0sWyJlcSIsIiR4LWFtei1kYXRlIiwiMjAxNjA0MDhUMTgyMzU2WiJdLFsiZXEiLCIkeC1hbXotYWxnb3JpdGhtIiwiQVdTNC1ITUFDLVNIQTI1NiJdLFsiZXEiLCIkeC1hbXotY3JlZGVudGlhbCIsIlEzQU0zVVE4NjdTUFFRQTQzUDJGLzIwMTYwNDA4L3VzLWVhc3QtMS9zMy9hd3M0X3JlcXVlc3QiXV19 -F x-amz-algorithm=AWS4-HMAC-SHA256 -F x-amz-credential=Q3AM3UQ867SPQQA43P2F/20160408/us-east-1/s3/aws4_request -F key=myotherobject.txt -F file=@<FILE>
share list command lists unexpired URLs that were previously shared
USAGE:
mc share list COMMAND
COMMAND:
upload: list previously shared access to uploads.
download: list previously shared access to downloads.
mirror command synchronizes data between filesystems and object storages, similarly to rsync.
USAGE:
mc mirror [FLAGS] SOURCE TARGET
FLAGS:
--overwrite overwrite object(s) on target if it differs from source
--dry-run perform a fake mirror operation
--watch, -w watch and synchronize changes
--remove remove extraneous object(s) on target
--region value specify region when creating new bucket(s) on target (default: "us-east-1")
--preserve, -a preserve file system attributes and bucket policy rules on target bucket(s)
--exclude value exclude object(s) that match specified object name pattern
--older-than value filter object(s) older than value in duration string (e.g. 7d10h31s)
--newer-than value filter object(s) newer than value in duration string (e.g. 7d10h31s)
--storage-class value, --sc value specify storage class for new object(s) on target
--encrypt value encrypt/decrypt objects (using server-side encryption with server managed keys)
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT: list of comma delimited prefixes
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
Example: Mirror a local directory to 'mybucket' on https://play.min.io.
mc mirror localdir/ play/mybucket
localdir/b.txt: 40 B / 40 B ┃▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓┃ 100.00 % 73 B/s 0
Example: Continuously watch for changes on a local directory and mirror the changes to 'mybucket' on https://play.min.io.
mc mirror -w localdir play/mybucket
localdir/new.txt: 10 MB / 10 MB ┃▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓┃ 100.00 % 1 MB/s 15s
find command finds files which match the given set of parameters. It only lists the contents which match the given set of criteria.
USAGE:
mc find PATH [FLAGS]
FLAGS:
--exec value spawn an external process for each matching object (see FORMAT)
--ignore value exclude objects matching the wildcard pattern
--name value find object names matching wildcard pattern
--newer value match all objects newer than value in duration string (e.g. 7d10h31s)
--older value match all objects older than value in duration string (e.g. 7d10h31s)
--path value match directory names matching wildcard pattern
--print value print in custom format to STDOUT (see FORMAT)
--regex value match directory and object name with PCRE regex pattern
--larger value match all objects larger than specified size in units (see UNITS)
--smaller value match all objects smaller than specified size in units (see UNITS)
--maxdepth value limit directory navigation to specified depth (default: 0)
--watch monitor a specified path for newly created object(s)
...
...
--help, -h show help
Example: Find all jpeg images from s3 bucket and copy to MinIO "play/bucket" bucket continuously.
mc find s3/bucket --name "*.jpg" --watch --exec "mc cp {} play/bucket"
diff command computes the differences between the two directories. It only lists the contents which are missing or which differ in size.
It DOES NOT compare the contents, so it is possible that the objects which are of same name and of the same size, but have difference in contents are not detected. This way, it can perform high speed comparison on large volumes or between sites
USAGE:
mc diff [FLAGS] FIRST SECOND
FLAGS:
--config-folder value, -C value Path to configuration folder. (default: "/root/.mc")
--quiet, -q Disable progress bar display.
--no-color Disable color theme.
--json Enable JSON formatted output.
--debug Enable debug output.
--insecure Disable SSL certificate verification.
--help, -h Show help.
LEGEND:
< - object is only in source.
> - object is only in destination.
! - newer object is in source.
Example: Compare a local directory and a remote object storage.
mc diff localdir play/mybucket
‘localdir/notes.txt’ and ‘https://play.min.io/mybucket/notes.txt’ - only in first.
JSON option enables parseable output in JSON lines format.
Example: diff json output.
mc diff minio1/diffbucket minio2/diffbucket --json
{"status":"success","first":"","second":"http://127.0.0.1:9001/diffbucket/file1.png","diff":5}
{"status":"success","first":"http://127.0.0.1:9000/diffbucket/file2.png","second":"","diff":4}
{"status":"success","first":"http://127.0.0.1:9000/diffbucket/file3.png","second":"http://127.0.0.1:9001/diffbucket/file3.png","diff":2}
{"status":"success","first":"http://127.0.0.1:9000/diffbucket/file4.png","second":"http://127.0.0.1:9001/diffbucket/file4.png","diff":1}
| Constant | Value | Meaning |
|---|---|---|
| differInUnknown | 0 | Could not perform diff due to error |
| differInNone | 1 | Does not differ |
| differInSize | 2 | Differs in size |
| differInMetadata | 3 | Differs in metadata |
| differInType | 4 | Differs in type exfile/directory |
| differInFirst | 5 | Only in source (FIRST) |
| differInSecond | 6 | Only in target (SECOND) |
| differInAASourceMTime | 7 | Differs in active-active source modtime |
watch provides a convenient way to watch on various types of event notifications on object
storage and filesystem.
USAGE:
mc watch [FLAGS] PATH
FLAGS:
--events value filter specific types of events, defaults to all events (default: "put,delete,get")
--prefix value filter events for a prefix
--suffix value filter events for a suffix
--recursive recursively watch for events
--help, -h show help
Example: Watch for all events on object storage
mc watch play/testbucket
[2016-08-18T00:51:29.735Z] 2.7KiB ObjectCreated https://play.min.io/testbucket/CONTRIBUTING.md
[2016-08-18T00:51:29.780Z] 1009B ObjectCreated https://play.min.io/testbucket/MAINTAINERS.md
[2016-08-18T00:51:29.839Z] 6.9KiB ObjectCreated https://play.min.io/testbucket/README.md
Example: Watch for all events on local directory
mc watch ~/Photos
[2016-08-17T17:54:19.565Z] 3.7MiB ObjectCreated /home/minio/Downloads/tmp/5467026530_a8611b53f9_o.jpg
[2016-08-17T17:54:19.565Z] 3.7MiB ObjectCreated /home/minio/Downloads/tmp/5467026530_a8611b53f9_o.jpg
...
[2016-08-17T17:54:19.565Z] 7.5MiB ObjectCreated /home/minio/Downloads/tmp/8771468997_89b762d104_o.jpg
event provides a convenient way to manage various types of event notifications on a bucket. MinIO event notification can be configured to use AMQP, Redis, ElasticSearch, NATS and PostgreSQL services. MinIO configuration provides more details on how these services can be configured.
USAGE:
mc event COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...]
COMMANDS:
add add a new bucket notification
remove remove a bucket notification. With '--force' can remove all bucket notifications
list list bucket notifications
FLAGS:
--ignore-existing, -p ignore if event already exists
--help, -h show help
Example: List all configured bucket notifications
mc event list play/andoria
MyTopic arn:minio:sns:us-east-1:1:TestTopic s3:ObjectCreated:*,s3:ObjectRemoved:* suffix:.jpg
Example: Add a new 'sqs' notification resource only to notify on ObjectCreated event
mc event add play/andoria arn:minio:sqs:us-east-1:1:your-queue --event put
Example: Add a new 'sqs' notification resource with filters
Add prefix and suffix filtering rules for sqs notification resource.
mc event add play/andoria arn:minio:sqs:us-east-1:1:your-queue --prefix photos/ --suffix .jpg
Example: Remove a 'sqs' notification resource
mc event remove play/andoria arn:minio:sqs:us-east-1:1:your-queue
ilm - A convenient way to manage bucket lifecycle configuration.
USAGE:
mc ilm COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...]
COMMANDS:
ls list lifecycle configuration rules set on a bucket
add add a lifecycle configuration rule to existing (if any) rule(s) on a bucket
rm remove (if any) existing lifecycle configuration rule
edit modify a lifecycle configuration rule with given id
export export lifecycle configuration in JSON format
import import lifecycle configuration in JSON format
FLAGS:
--help, -h show help
Example: List the lifecycle management rules
mc ilm ls myminio/testbucket
ID | Prefix | Enabled | Expiry | Date/Days | Transition | Date/Days | Storage-Class | Tags
---------|--------|---------|--------|--------------|------------|-----------|---------------|------
Devices | dev/ | ✓ | ✓ | 17 Sep 2020 | ✗ | | |
---------|--------|---------|--------|--------------|------------|-----------|---------------|------
For more details about the lifecycle configuration, refer to official AWS S3 documentation here
Example: Edit the lifecycle management configuration rule given by ID "btd6pdot8748n94elvl0" to set tags
mc ilm edit --id "Documents" --tags "k1=v1&k2=v2" play/testbucket/dev
Lifecycle configurtaion rule with ID `btd6pdot8748n94elvl0` modified to play/testbucket/dev.
Example: Remove the lifecycle management configuration rule given by ID "Documents"
mc ilm rm --id "Documents" play/testbucket/dev
Rule ID `Documents` from target play/testbucket/dev removed.
Manage anonymous bucket policies to a bucket and its contents
USAGE:
mc policy [FLAGS] set PERMISSION TARGET
mc policy [FLAGS] set-json FILE TARGET
mc policy [FLAGS] get TARGET
mc policy [FLAGS] get-json TARGET
mc policy [FLAGS] list TARGET
PERMISSION:
Allowed policies are: [private, public, download, upload].
FILE:
A valid S3 policy JSON filepath.
FLAGS:
--help, -h show help
Example: Show current anonymous bucket policy
Show current anonymous bucket policy for mybucket/myphotos/2020/ sub-directory
mc policy get play/mybucket/myphotos/2020/
Access permission for ‘play/mybucket/myphotos/2020/’ is ‘none’Example : Set anonymous bucket policy to download only
Set anonymous bucket policy for mybucket/myphotos/2020/ sub-directory and its objects to download only. Now, objects under the sub-directory are publicly accessible. e.g mybucket/myphotos/2020/yourobjectnameis available at https://play.min.io:9000/mybucket/myphotos/2020/yourobjectname
mc policy set download play/mybucket/myphotos/2020/
Access permission for ‘play/mybucket/myphotos/2020/’ is set to 'download'Example : Set anonymous bucket policy from a JSON file
Configure bucket policy for mybucket with a policy JSON file.
mc policy set-json /tmp/policy.json play/mybucket
Access permission for `play/mybucket` is set from `/tmp/policy.json`Example : Set current anonymous bucket policy to private
Set anonymous bucket policy for mybucket/myphotos/2020/ sub-directory to private. This is equivalent to removing any bucket policies.
mc policy set private play/mybucket/myphotos/2020/
Access permission for ‘play/mybucket/myphotos/2020/’ is set to 'private' tag command provides a convenient way to set, remove, and list bucket/object tags. Tags are defined as key-value pairs.
USAGE:
mc tag COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...]
COMMANDS:
list list tags of a bucket or an object
remove remove tags assigned to a bucket or an object
set set tags for a bucket or an object
FLAGS:
--help, -h show help
--json enable JSON formatted output
--debug enable debug output
Example : List tags assigned to an object
List tags for testobject in testbucket in alias s3
mc tag list s3/testbucket/testobject
Name : testobject
editable : only-by-owner-and-authenticated
confidentiality : open-to-authenticated-only
Example : Set tags for an object
Set tags for testobject in testbucket in alias s3
mc tag set s3/testbucket/testobject "key1=value1&key2=value2&key3=value3"
Tags set for s3/testbucket/testobject.
Example : Remove tags assigned to an object
Remove tags assigned to testobject in testbucket in alias s3
mc tag remove s3/testbucket/testobject
Tags removed for s3/testbucket/testobject.
Example: Assign tags to a object versions older than one week
mc tag set --versions --rewind 7d play/testbucket/testobject "status=old"
Please visit here for a more comprehensive admin guide.
alias command provides a convenient way to manage aliases entries in your config file ~/.mc/config.json. It is also OK to edit the config file manually using a text editor.
USAGE:
mc alias COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...]
COMMANDS:
set, s add a new alias to configuration file
remove, rm remove an alias from configuration file
list, ls lists aliases in configuration file
FLAGS:
--help, -h show help
Example: Manage Config File
Add MinIO server access and secret keys to config file alias entry. Note that, the history feature of your shell may record these keys and pose a security risk. On bash shell, use set -o and set +o to disable and enable history feature momentarily.
set +o history
mc alias set myminio http://localhost:9000 OMQAGGOL63D7UNVQFY8X GcY5RHNmnEWvD/1QxD3spEIGj+Vt9L7eHaAaBTkJ
set -o history
Remove the alias from the config file.
mc alias remove myminio
List all configured aliases
mc alias list
Check for new software updates from https://dl.min.io. Experimental flag checks for unstable experimental releases primarily meant for testing purposes.
USAGE:
mc update [FLAGS]
FLAGS:
--quiet, -q suppress chatty console output
--json enable JSON formatted output
--help, -h show help
Example: Check for an update.
mc update
You are already running the most recent version of ‘mc’.
stat command displays information on objects (with optional prefix) contained in the specified bucket on an object storage. On a filesystem, it behaves like stat command.
USAGE:
mc stat [FLAGS] TARGET
FLAGS:
--rewind value stat on older version(s)
--versions stat all versions
--version-id value, --vid value stat a specific object version
--recursive, -r stat all objects recursively
--encrypt-key value encrypt/decrypt objects (using server-side encryption with customer provided keys)
--help, -h show help
ENVIRONMENT VARIABLES:
MC_ENCRYPT_KEY: list of comma delimited prefix=secret values
Example: Display information on a bucket named "mybucket" on https://play.min.io.
mc stat play/mybucket
Name : mybucket/
Date : 1969-12-31 16:00:00 PST
Size : 0 B
Type : folder
Metadata :
Encryption: Not Set
Versioning: Enabled
LockConfiguration:
RetentionMode: COMPLIANCE
Retention Until Date: 1DAYS
Notification: Unset
Replication: Enabled
Policy: none
Location: us-east-1
Tagging: key1:value1, key2:value2
ILM: Not Set
Example: Display information on an encrypted object "myobject" in "mybucket" on https://play.min.io.
mc stat play/mybucket/myobject --encrypt-key "play/mybucket=32byteslongsecretkeymustbegiven1"
Name : myobject
Date : 2018-03-02 11:47:13 PST
Size : 132B
ETag : d03ba22cd78282b7aef705bf31b8cded
Type : file
Metadata :
Content-Type : application/octet-stream
X-Amz-Server-Side-Encryption-Customer-Key-Md5 : 4xSRdYsabg+s2nlsHKhgnw==
X-Amz-Server-Side-Encryption-Customer-Algorithm: AES256
Example: Display information on objects contained in the bucket named "mybucket" on https://play.min.io.
mc stat -r play/mybucket
Name : mybucket/META/textfile
Date : 2018-02-06 18:17:38 PST
Size : 1024B
ETag : d41d8cd98f00b204e9800998ecf8427e
Type : file
Metadata :
Content-Type: application/octet-stream
Name : mybucket/emptyfile
Date : 2018-02-06 18:16:14 PST
Size : 100B
ETag : d41d8cd98f00b204e9800998ecf8427e
Type : file
Metadata :
Content-Type: application/octet-stream
Example: Stat a specific object version
mc stat --version-id "CL3sWgdSN2pNntSf6UnZAuh2kcu8E8si" s3/personal-docs/2018-account_report.docx
Name : s3/personal-docs/2018-account_report.docx
Date : 2018-02-06 18:16:14 PST
Size : 100B
ETag : d41d8cd98f00b204e9800998ecf8427e
Type : file
Metadata :
Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
version manage bucket versioning
NAME:
mc version - manage bucket versioning
USAGE:
mc version TARGET [enable | suspend | info]
COMMANDS:
enable Enable bucket versioning
suspend Suspend bucket versioning
info Show bucket versioning status
Example: Enable versioning on bucket mybucket
mc version enable myminio/mybucket
myminio/mybucket versioning is enabled
Example: Display the version configuration for bucket mybucket
mc version info myminio/mybucket
myminio/mybucket versioning status is enabled
Example: Suspend versioning for bucket mybucket
mc version suspend myminio/mybucket
myminio/mybucket versioning is suspended
undo reverts latest PUT/DELETE operations
NAME:
mc undo - undo PUT/DELETE operations
USAGE:
mc undo [FLAGS] SOURCE
FLAGS:
--recursive, -r undo last S3 put/delete operations
--force force recursive operation
--last value undo N last changes (default: 1)
--dry-run fake an undo operation
--help, -h show help
Example: Undo the last 3 uploads and/or removals of a particular object
mc undo s3/backups/file.zip --last 3
✓ Last delete of `CREDITS` is reverted.
✓ Last upload of `CREDITS` (vid=mj2juHIoyvU94s8kIim5H.Z9L0QO50wO) is reverted.
✓ Last upload of `CREDITS` (vid=przFKd1iWC7ts_8FNoIvLae8NH_BAi_X) is reverted.
encrypt manages bucket encryption config
NAME:
mc encrypt - manage bucket encryption config
USAGE:
mc encrypt COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...]
COMMANDS:
set Set encryption config
clear Clear encryption config
info Show bucket encryption status
FLAGS:
--help, -h show help
Example: Display bucket encryption status for bucket mybucket
mc encrypt info myminio/mybucket
Algorithm: AES256
Example: Set SSE-S3 auto encryption for bucket mybucket on alias myminio
mc encrypt set sse-s3 myminio/mybucket
Auto encryption has been set successfully for myminio/source
Example: Set SSE-KMS auto encryption for bucket mybucket on alias myminio with KMS Key Id "arn:aws:kms:us-east-1:xxx:key/xxx"
mc encrypt set sse-kms "arn:aws:kms:us-east-1:xxx:key/xxx" myminio/mybucket
Auto encryption has been set successfully for myminio/source
Example: Clear auto encryption config for bucket mybucket on alias myminio
mc encrypt clear myminio/mybucket
Auto encryption configuration has been cleared successfully.
replicate manages bucket server side replication
NAME:
mc replicate - manage bucket server side replication
USAGE:
mc replicate COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...]
COMMANDS:
add add a server side replication configuration rule
edit modify an existing server side replication cofiguration rule
ls list server side replication configuration rules
export export server side replication configuration
import import server side replication configuration in JSON format
rm remove a server side replication configuration rule(s)
FLAGS:
--help, -h show help
Example: Add replication configuration rule on mybucket on alias myminio. Enable delete marker replication and replication of versioned deletes for the configuration
mc replicate add myminio/mybucket/prefix --tags "key1=value1&key2=value2" --storage-class "STANDARD" --remote-bucket 'arn:minio:replication:us-east-1:c5be6b16-769d-432a-9ef1-4567081f3566:destbucket' --priority 1 --replicate "delete-marker,delete"
Replication configuration rule applied to myminio/mybucket/prefix.
Example: Disable replication configuration rule with rule Id "bsibgh8t874dnjst8hkg" on bucket "mybucket" with prefix "prefix" for alias myminio
mc replicate edit myminio/mybucket/prefix --id "bsibgh8t874dnjst8hkg" --state disable
Replication configuration rule with ID `bsibgh8t874dnjst8hkg` applied to myminio/mybucket/prefix.
Example: Change priority of rule with rule ID "bsibgh8t874dnjst8hkg" on bucket "mybucket" for alias myminio.
mc replicate edit myminio/mybucket/prefix --id "bsibgh8t874dnjst8hkg" --priority 3
Replication configuration rule with ID `bsibgh8t874dnjst8hkg` applied to myminio/mybucket/prefix.
Example: Clear tags on rule ID "bsibgh8t874dnjst8hkg" for target myminio/bucket which has a replication configuration rule with prefix "prefix"
mc replicate edit myminio/mybucket/prefix --id "bsibgh8t874dnjst8hkg" --tags ""
Replication configuration rule with ID `bsibgh8t874dnjst8hkg` applied to myminio/mybucket/prefix successfully.
*Example: Enable delete marker replication and versioned delete replication on rule ID "bsibgh8t874dnjst8hkg" for target myminio/bucket which has a replication configuration rule with prefix "prefix"
mc replicate edit myminio/mybucket/prefix --id "bsibgh8t874dnjst8hkg" --replicate "delete,delete-marker"
Replication configuration rule with ID `bsibgh8t874dnjst8hkg` applied to myminio/mybucket/prefix successfully.
*Example: Disable delete marker and versioned delete replication on rule ID "bsibgh8t874dnjst8hkg" for target myminio/bucket which has a replication configuration rule with prefix "prefix"
mc replicate edit myminio/mybucket/prefix --id "bsibgh8t874dnjst8hkg" --replicate ""
Replication configuration rule with ID `bsibgh8t874dnjst8hkg` applied to myminio/mybucket/prefix successfully.
Example: List replication configuration rules set on mybucket on alias myminio
mc replicate ls myminio/mybucket
Example: Clear replication configuration for bucket mybucket on alias myminio
mc replicate rm --all --force myminio/mybucket
Replication configuration has been removed successfully for myminio/mybucket
Example: Remove replication configuration rule with id bsibgh8t874dnjst8hkg for bucket mybucket on alias myminio
mc replicate rm --id "bsibgh8t874dnjst8hkg" myminio/mybucket/prefix
Replication configuration rule with id "bsibgh8t874dnjst8hkg" has been removed successfully for myminio/mybucket
Example: Import replication configuration for bucket mybucket on alias myminio from /data/replicate/config
mc replicate import myminio/mybucket < /data/replicate/config
Replication configuration successfully set on `myminio/mybucket`.
Example: Export replication configuration for bucket mybucket on alias myminio to /data/replicate/config
mc replicate export myminio/mybucket > /data/replicate/config
Example: Show replication status of mybucket on alias myminio
mc replicate status myminio/mybucket
*Example: Resync replication of previously replicated objects from mybucket on alias myminio to remote target "arn:minio:replication::xxx:mybucket".
mc replicate resync start myminio/mybucket --remote-bucket "arn:minio:replication::xxx:mybucket"
*Example: Show status of replication resync of target "arn:minio:replication::xxx:mybucket" for mybucket on alias myminio.
mc replicate resync status myminio/mybucket --remote-bucket "arn:minio:replication::xxx:mybucket"
NAME:
mc support register register with MinIO subscription network
mc support callhome configure callhome settings
mc support diag, diagnostics upload health data for diagnostics
mc support perf analyze object, network and drive performance
mc support inspect upload raw object contents for analysis
mc support profile generate profile data for debugging
mc support logs configure/display MinIO console logs
mc support top provide top like statistics for MinIO
Register MinIO cluster at alias 'play' on SUBNET, using the name "play-cluster".
mc support register play --name play-cluster
Enable logs callhome for cluster with alias 'play'.
mc support callhome set play logs=on
Download 'xl.meta' for a specific object from all the drives in a zip file.
mc support inspect myminio/bucket/test*/xl.meta
Run object speed measurement with autotuning the concurrency to obtain maximum throughput and IOPs.
mc support perf object myminio/
Upload MinIO diagnostics report for 'play' (https://play.min.io by default) to SUBNET
mc support diag play
Get CPU profiling for 2 minutes
mc support profile --type cpu --duration 120 myminio/
Print last 5 application error logs entries for node 'node1' on MinIO server with alias 'myminio'
mc support logs show --last 5 --type application myminio node1
Enable logs for cluster with alias 'play'
mc support logs enable play
Get a list of the 10 oldest locks on a distributed MinIO cluster, where 'myminio' is the MinIO cluster alias.*
mc admin top locks myminio
Display current in-progress all 's3.PutObject' API calls.
mc support top api --name s3.PutObject myminio/
rb command to perform liveness check
USAGE:
mc ping [FLAGS] TARGET
FLAGS:
--count value, -c value perform liveliness check for count number of times (default: 0)
--error-count value, -e value exit after N consecutive ping errors
--interval value, -i value wait interval between each request in seconds (default: 1)
--distributed, -a ping all the servers in the cluster, use it when you have direct access to nodes/pods
--help, -h show help
Example: Perform liveness check on https://play.min.io.
mc ping play
1: https://play.min.io: min=919.538ms max=919.538ms average=919.538ms errors=0 roundtrip=919.538ms
2: https://play.min.io: min=278.356ms max=919.538ms average=598.947ms errors=0 roundtrip=278.356ms
3: https://play.min.io: min=278.356ms max=919.538ms average=504.759ms errors=0 roundtrip=316.384ms