Skip to content
MinIO Client is a replacement for ls, cp, mkdir, diff and rsync commands for filesystems and object storage.
Go Shell Other
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add go.yml github workflow (#2902) Sep 20, 2019
buildscripts Migrate to go1.13 (#2888) Sep 8, 2019
cmd Rectify usage section of policy help (#2959) Nov 15, 2019
docs add lock command (#2880) Nov 11, 2019
pkg Add options to preserve filesystem attributes (#2938) Oct 30, 2019
.gitignore Vendorize all the latest dependencies with go mod (#2674) Feb 9, 2019
.mailmap Adds missing codebase MinIO and changes (#2745) Apr 17, 2019 mc command cleanup (#2783) Jun 27, 2019 mc command cleanup (#2783) Jun 27, 2019
Dockerfile update docker alpine base image to 3.10 (#2920) Oct 8, 2019
Dockerfile.release update docker alpine base image to 3.10 (#2920) Oct 8, 2019
LICENSE Add Apache License v2.0 Jan 17, 2015
Makefile Build staticcheck as pre-built binaries are not available on s390x (#… Sep 12, 2019
NOTICE Adds missing codebase MinIO and changes (#2745) Apr 17, 2019 README: update minimum go version (#2923) Oct 7, 2019 Fix broken link to go installation docs (#2866) Aug 15, 2019 Add contributors file May 23, 2015 Add options to preserve filesystem attributes (#2938) Oct 30, 2019
go.mod update to latest minio (#2957) Nov 14, 2019
go.sum update to latest minio (#2957) Nov 14, 2019
main.go Migrate to go1.13 (#2888) Sep 8, 2019
staticcheck.conf Add staticcheck based builds (#2788) Jun 3, 2019

MinIO Client Quickstart Guide

Slack Go Report Card Docker Pulls

MinIO Client (mc) provides a modern alternative to UNIX commands like ls, cat, cp, mirror, diff, find etc. It supports filesystems and Amazon S3 compatible cloud storage service (AWS Signature v2 and v4).

ls       list buckets and objects
mb       make a bucket
rb       remove a bucket
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
cp       copy objects
mirror   synchronize objects to a remote site
find     search for objects
sql      run sql queries on objects
stat     stat contents of objects
diff     list differences in object name, size, and date between buckets
rm       remove objects
event    manage object notifications
watch    watch for object events
policy   manage anonymous access to objects
admin    manage MinIO servers
session  manage saved sessions for cp command
config   manage mc configuration file
update   check for a new software update
version  print version info

Docker Container


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 config command.



Install mc packages using Homebrew

brew install minio/stable/mc
mc --help


Binary Download

Platform Architecture URL
GNU/Linux 64-bit Intel
64-bit PPC
chmod +x mc
./mc --help

Microsoft Windows

Binary Download

Platform Architecture URL
Microsoft Windows 64-bit Intel
mc.exe --help

Install from Source

Source installation is only intended for developers and advanced users. If you do not have a working Golang environment, please follow How to install Golang. Minimum version required is go1.13

GO111MODULE=on go get

Add a Cloud Storage Service

If you are planning to use mc only on POSIX compatible filesystems, you may skip this step and proceed to everyday use.

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.


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

Lookup is an optional argument. It is used to indicate whether dns or path style url requests are supported by the server. It accepts "dns", "path" or "auto" as valid values. By default, it is set to "auto" and SDK automatically determines the type of url lookup to use.

Example - MinIO Cloud Storage

MinIO server displays URL, access and secret keys.

mc config host add minio BKIKJAA5BMMU2RHO6IBB V7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12

Example - Amazon S3 Cloud Storage

Get your AccessKeyID and SecretAccessKey by following AWS Credentials Guide.

mc config host add s3 BKIKJAA5BMMU2RHO6IBB V7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12

Note: As an IAM user on Amazon S3 you need to make sure the user has full access to the buckets or set the following restricted policy for your IAM user

    "Version": "2012-10-17",
    "Statement": [
            "Sid": "AllowBucketStat",
            "Effect": "Allow",
            "Action": [
            "Resource": "*"
            "Sid": "AllowThisBucketOnly",
            "Effect": "Allow",
            "Action": "s3:*",
            "Resource": [

Example - Google Cloud Storage

Get your AccessKeyID and SecretAccessKey by following Google Credentials Guide

mc config host add gcs BKIKJAA5BMMU2RHO6IBB V8f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12

Test Your Setup

mc is pre-configured with, 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.


List all buckets from

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/

Make a bucket mb command creates a new bucket.


mc mb play/mybucket
Bucket created successfully `play/mybucket`.

Copy Objects cp command copies data from one or more sources to a target.


mc cp myobject.txt play/mybucket
myobject.txt:    14 B / 14 B  ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓  100.00 % 41 B/s 0

Everyday Use

Shell aliases

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'

Shell autocompletion

In case you are using bash, zsh or fish. Shell completion is embedded by default in mc, to install auto-completion use mc --autocompletion. Restart the shell, mc will auto-complete commands as shown below.

mc <TAB>
admin    config   diff     find     ls       mirror   policy   session  sql      update   watch
cat      cp       event    head     mb       pipe     rm       share    stat     version

Explore Further

Contribute to MinIO Project

Please follow MinIO Contributor's Guide


FOSSA Status

You can’t perform that action at this time.