Command Quick Reference
Command quick reference
The following table lists all top-level mc commands, excluding the mc admin commands.
| Command | Description |
|---|---|
mc alias | The mc alias commands provide a convenient interface for managing the list of S3-compatible hosts that mc can connect to and run operations against. |
mc anonymous | The mc anonymous command supports setting or removing anonymous policies to a bucket and its contents. Buckets with anonymous policies allow public access where clients can perform any action granted by the policy without authentication. |
mc batch | The mc batch commands allow you to run one or more job tasks on a MinIO AIStor deployment. |
mc cat | The mc cat command concatenates the contents of a file or object to another file or object. You can also use the command to display the contents of the specified file or object to STDOUT. cat has similar functionality to cat. |
mc cp | The mc cp command copies objects to or from a MinIO AIStor deployment, where the source can MinIO AIStor or a local filesystem. |
mc diff | The mc diff command computes the differences between two filesystem directories or MinIO AIStor buckets. mc diff lists only those objects which are missing or which differ in size. mc diff does not compare the contents of objects. |
mc du | The mc du command summarizes the disk usage of buckets and folders. You can also use du against the local filesystem to produce similar results as the du command. |
mc encrypt | The mc encrypt commands set, update, or disable the default bucket Server-Side Encryption (SSE) mode. MinIO AIStor automatically encrypts objects using the specified SSE mode. |
mc event | The mc event command supports adding, removing, and listing bucket event notifications. |
mc find | The mc find command supports searching for objects on a MinIO AIStor deployment.You can also use the command to search for files on a filesystem. |
mc get | The mc get command downloads an object from a target S3 deployment to the local file system. |
mc head | The mc head command displays the first n lines of an object, where n is an argument specified to the command. |
mc idp ldap | The mc idp ldap commands allow you to manage configurations to 3rd party Active Directory or LDAP Identity and Access Management (IAM) integrations. |
mc idp openid | The mc idp openid commands allow you to manage configurations to 3rd party OpenID Identity and Access Management (IAM) integrations. |
mc idp ldap policy | The mc idp ldap policy commands show the mapping relationships between policies and the associated groups or users. |
mc ilm rule | The mc ilm commands manage object lifecycle management rules on a MinIO AIStor deployment. |
mc ilm tier | The mc ilm commands manage tiering on a MinIO AIStor deployment. |
mc legalhold | The mc legalhold command sets, removes, or retrieves the object legal hold (WORM) settings for object(s). |
mc license | The mc license commands work with cluster registration for MinIO SUBNET. Use the commands to register a deployment, display information about the cluster’s current license, or update the license key for a cluster. |
mc ls | The mc ls command lists buckets and objects on MinIO AIStor or another S3-compatible service. |
mc mb | The mc mb command creates a new bucket or directory at the specified path. |
mc mirror | The mc mirror command synchronizes content to MinIO AIStor deployment, similar to the rsync utility.mc mirror supports filesystems, MinIO AIStor deployments, and other S3-compatible hosts as the synchronization source. |
mc mv | The mc mv command moves an object from source to the target, such as between MinIO AIStor deployments or between buckets on the same MinIO AIStor deployment. mc mv also supports moving objects between a local filesystem and MinIO AIStor. |
mc od | The mc od command copies a local file to a remote location in a specified number of parts and part sizes. The command outputs the time it took to upload the file. |
mc ping | The mc ping command performs a liveness check on a specified target. |
mc pipe | The mc pipe command streams content from STDIN to a target object. |
mc put | The mc put uploads an object from the local file system to a bucket on a target S3 deployment. |
mc quota | The mc quota commands configure, display, or clear a hard quota on a bucket. This command replaces the deprecated mc admin bucket quota. |
mc rb | The mc rb command removes one or more buckets on MinIO AIStor or another S3-compatible service.To remove only the contents of a bucket, use mc rm instead. |
mc ready | The mc ready command checks the status of a cluster and whether the cluster has read and write quorum. |
mc replicate | The mc replicate command configures and manages the Server-Side Bucket Replication for a MinIO AIStor deployment, including active-active replication configurations and resynchronization. |
mc retention | The mc retention command configures the Write-Once Read-Many (WORM) locking settings for an object or object(s) in a bucket. You can also set the default object lock settings for a bucket, where all objects without explicit object lock settings inherit the bucket default. |
mc rm | The mc rm command removes objects from a bucket on a MinIO AIStor deployment. To completely remove a bucket, use mc rb instead. |
mc share | Use the mc share commands to manage presigned URLs for downloading and uploading objects to a MinIO AIStor bucket. |
mc sql | The mc sql command provides an S3 Select interface for performing sql queries on objects in the specified MinIO AIStor deployment. |
mc stat | The mc stat command displays information on objects in a MinIO AIStor bucket, including object metadata. You can also use it to retrieve bucket metadata. |
mc support | The AIStor Client mc support commands provide tools for analyzing deployment health or performance and for running diagnostics. You can also upload generated health reports for further analysis by MinIO AIStor engineering. |
mc tag | The mc tag command adds, removes, and lists tags associated to a bucket or object. |
mc tree | The mc tree command lists all prefixes inside a MinIO AIStor bucket in a tree format. The command optionally supports listing all objects inside of bucket at each prefix, including the bucket root. |
mc undo | The mc undo command reverses changes due to either a PUT or DELETE operation at a specified path. |
mc update | The mc update command automatically updates the mc binary to the latest stable version. |
mc version | The mc version commands enable, disable, and retrieve the versioning status for a MinIO AIStor bucket. |
mc watch | The mc watch command watches for events on the specified MinIO AIStor bucket or local filesystem path. For S3 services, use mc event add to configure bucket event notifications on S3-compatible services. |