my-docs/Storage/Minio/Client/basic.md

The MinIO Client (mc) provides a modern alternative to UNIX commands for interacting with S3-compatible object storage. This guide summarizes commonly used commands.

---

Aliases (mc alias)

Aliases are used to manage S3 server connections.

• List all aliases:

mc alias ls

• List a specific alias:

mc alias ls <mc-server>

• Remove an alias:

mc alias rm <mc-server>

• Set a new alias:

mc alias set <object-storage-name> <url> <access-key> <secret-key> --api <s3-version>

• Export alias to JSON:

mc alias export <mc-server> | tee object-st.json

• Import alias from JSON:

mc alias import <object-storage-name> <json-file>

---

Listing Objects (mc ls)

• List bucket contents:

mc ls <mc-server>/<bucket>/<dir>/

• List with versions:

mc ls --versions <mc-server>/<bucket>/<dir>/

---

Copying Files (mc cp)

• Upload file to bucket:

mc cp <file-onlocal> <mc-server>/<bucket>/<dir>/

• Download file from bucket:

mc cp <mc-server>/<bucket>/<dir> <file-onlocal>

• Download specific version:

mc cp --version-id <version-uuid> <mc-server>/<bucket>/<dir> <file-onlocal>

---

Viewing Files (mc cat)

• View file contents:

mc cat <mc-server>/<bucket>/<dir>

---

Moving Files (mc mv)

• Move from local to bucket:

mc mv <file-onlocal> <mc-server>/<bucket>/<dir>/

• Move specific version from bucket:

mc mv --version-id <version-uuid> <mc-server>/<bucket>/<dir> <file-onlocal>

---

Removing Files (mc rm)

• Remove file:

mc rm <mc-server>/<bucket>/<dir>/file

• Force remove specific version:

mc rm --force --version-id <version-uuid> <mc-server>/<bucket>/<dir>/file

---

Creating Buckets (mc mb)

• Create a bucket:

mc mb <mc-server>/<bucket-name>

• Create a bucket with versioning:

mc mb --with-versioning <mc-server>/<bucket-name>

• Create a bucket with object lock:

mc mb --with-lock <mc-server>/<bucket-name>

---

Removing Buckets (mc rb)

• Remove a bucket:

mc rb <mc-server>/<bucket-name>

• Force remove a bucket:

mc rb --force <mc-server>/<bucket-name>

---

Health Check (mc ping)

• Ping a server:

mc ping <mc-server> --count <count-of-ping>

---

Tree View (mc tree)

• Display bucket tree structure:

mc tree <mc-server>/<bucket>