4/18/2017 GitHubminio/mc:MinioClientisareplacementforls,cp,mkdir,diffandrsynccommandsforfilesystemsandobjectstorage.

Features Business Explore Pricing This repository Search Sign in or Sign up

minio / mc Watch 32 Star 471 Fork 68

Code Issues 16 Pull requests 2 Projects 0 Pulse Graphs

Minio Client is a replacement for ls, cp, mkdir, diff and rsync commands for filesystems and object storage.
https://minio.io/downloads/#minioclient
storage googlecloudstorage awss3 filesystem s3 go tools coreutils

3,186 commits 4 branches 24 releases 26 contributors Apache2.0

Branch: master New pull request Find file Clone or download

badscooter23 committed with harshavardhana minor fixes to `mc share download` command #2106 Latest commit 9eb967c 9 hours ago

.github Create ISSUE_TEMPLATE.md #1783 9 months ago

autocomplete cli: Add bash and zsh autocomplete #2095 20 days ago

buildscripts Fix macOS build #2041 2 months ago

cmd minor fixes to `mc share download` command #2106 9 hours ago

docs docs: Fix brew command to install mc. #2121 7 days ago

pkg Move the notify events to new package rjeczalik/notify. #1807 8 months ago

tests Code: Fixed spelling mistake in files listed. #1797 8 months ago

vendor madmin: Update and adapt mc to new lib changes #2131 a day ago

.gitignore Add code coverage and cleanup CI configs. #1795 8 months ago

.mailmap update AB's contributors email 2 years ago

.travis.yml Move to go1.8 for all builds. #2019 2 months ago

CONFLICT.md Add conflict document regarding midnight commander #2021 2 months ago

CONTRIBUTING.md mc: Vendorize to new API changes. a year ago

Dockerfile Move to go1.8 for all builds. #2019 2 months ago

LICENSE Add Apache License v2.0 2 years ago

Makefile Remove references for GO15VENDOREXPERIMENT=1 3 months ago

NOTICE Rename all http references to https 2 years ago

README.md docs: Fix README.md to reference edge container. #2118 9 days ago

appveyor.yml Move to go1.8 for all builds. #2019 2 months ago

contributors.sh Add contributors file 2 years ago

main.go mc: Introduce new Dockerfile for mc. #1938 4 months ago

README.md

Minio Client Quickstart Guide slackchannel 659

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.
https://github.com/minio/mc 1/5
4/18/2017 GitHubminio/mc:MinioClientisareplacementforls,cp,mkdir,diffandrsynccommandsforfilesystemsandobjectstorage.

lsListfilesandfolders.
mbMakeabucketorfolder.
catDisplaycontentsofafile.
pipeWritecontentsofstdintotarget.Whennotargetisspecified,itwritestostdout.
shareGenerateURLforsharing.
cpCopyoneormoreobjectstoatarget.
mirrorMirrorfoldersrecursivelyfromasinglesourcetosingledestination.
diffComputedifferencesbetweentwofolders.
rmRemovefileorbucket[WARNING:Usewithcare].
eventsManagebucketnotification.
watchWatchforeventsonobjectstorageandfilesystem.
policy Setpublicpolicyonbucketorprefix.
sessionManagesavedsessionsofcpandmirroroperations.
configManageconfigurationfile.
updateCheckforanewsoftwareupdate.
versionPrintversion.

Docker Container

Stable

dockerpullminio/mc
dockerrunminio/mclsplay

Edge

dockerpullminio/mc:edge
dockerrunminio/mc:edgelsplay

macOS

Homebrew
Install mc packages using Homebrew

brewinstallminio/stable/mc
mchelp

GNU/Linux

Binary Download

Platform Architecture URL

GNU/Linux 64bit Intel https://dl.minio.io/client/mc/release/linuxamd64/mc

32bit Intel https://dl.minio.io/client/mc/release/linux386/mc

32bit ARM https://dl.minio.io/client/mc/release/linuxarm/mc

chmod+xmc
./mchelp

Microsoft Windows

Binary Download
https://github.com/minio/mc 2/5
4/18/2017 GitHubminio/mc:MinioClientisareplacementforls,cp,mkdir,diffandrsynccommandsforfilesystemsandobjectstorage.

Binary Download

Platform Architecture URL

Microsoft Windows 64bit https://dl.minio.io/client/mc/release/windowsamd64/mc.exe

32bit https://dl.minio.io/client/mc/release/windows386/mc.exe

mc.exehelp

FreeBSD

Binary Download

Platform Architecture URL

FreeBSD 64bit https://dl.minio.io/client/mc/release/freebsdamd64/mc

chmod755mc
./mchelp

Solaris/Illumos

From Source

gogetugithub.com/minio/mc
mchelp

Install from Source

Source installation is intended only for developers and advanced users. mcupdate command does not support update
notifications for source based installations. Please download official releases from https://minio.io/downloads/#minioclient.

If you do not have a working Golang environment, please follow How to install Golang.

gogetugithub.com/minio/mc

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.

mcconfighostadd<ALIAS><YOURS3ENDPOINT><YOURACCESSKEY><YOURSECRETKEY><APISIGNATURE>

Alias is simply a short name to you cloud storage service. S3 endpoint, access and secret keys are supplied by your cloud
storage provider. API signature is an optional argument. By default, it is set to "S3v4".

Example Minio Cloud Storage

Minio server displays URL, access and secret keys.

https://github.com/minio/mc 3/5
4/18/2017 GitHubminio/mc:MinioClientisareplacementforls,cp,mkdir,diffandrsynccommandsforfilesystemsandobjectstorage.

mcconfighostaddminiohttp://192.168.1.51BKIKJAA5BMMU2RHO6IBBV7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12S3v4

Example Amazon S3 Cloud Storage

Get your AccessKeyID and SecretAccessKey by following AWS Credentials Guide.

mcconfighostadds3https://s3.amazonaws.comBKIKJAA5BMMU2RHO6IBBV7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12S3v4

Example Google Cloud Storage

Get your AccessKeyID and SecretAccessKey by following Google Credentials Guide

mcconfighostaddgcshttps://storage.googleapis.comBKIKJAA5BMMU2RHO6IBBV8f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12S3v2

NOTE: Google Cloud Storage only supports Legacy Signature Version 2, so you have to pick S3v2

Test Your Setup

mc is preconfigured with https://play.minio.io:9000, 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.minio.io:9000

mclsplay
[2016032219:47:48PDT]0Bmybucketname/
[2016032222:01:07PDT]0Bmytestbucket/
[2016032220:04:39PDT]0Bmybucketname/
[2016012817:23:11PST]0Bnewbucket/
[2016032009:08:36PDT]0Bs3gittest/

Everyday Use

Shell aliases
You may add shell aliases to override your common Unix tools.

aliasls='mcls'
aliascp='mccp'
aliascat='mccat'
aliasmkdir='mcmb'
aliaspipe='mcpipe'

Shell autocompletion
You may also download autocomplete/bash_autocomplete into /etc/bash_completion.d/ and rename it to mc. Don't forget to
source the file to make it active on your current shell.

sudowgethttps://raw.githubusercontent.com/minio/mc/master/autocomplete/bash_completeO/etc/bash_completion.d/mc
source/etc/bash_completion.d/mc

https://github.com/minio/mc 4/5
4/18/2017 GitHubminio/mc:MinioClientisareplacementforls,cp,mkdir,diffandrsynccommandsforfilesystemsandobjectstorage.

mc<TAB>
adminconfigdifflsmirrorpolicysessionupdatewatch
catcpeventsmbpipermshareversion

Explore Further
Minio Client Complete Guide
Minio Quickstart Guide
The Minio documentation website

Contribute to Minio Project

Please follow Minio Contributor's Guide

2017 GitHub, Inc. Terms Privacy Security Status Help Contact GitHub API Training Shop Blog About

https://github.com/minio/mc 5/5