Welcome to the upcoming version of the MinIO Documentation! The content on this page is under active development and may change at any time. If you can't find what you're looking for, check our legacy documentation. Thank you for your patience.

mc alias list

Syntax

The mc alias list command lists all aliases in the local mc configuration.

The command output includes the configured access key and secret key associated to each alias.

The following command lists all aliases configured on the local host machine:

mc alias list

The mc alias list command has the following syntax:

mc [GLOBALFLAGS] alias list [ALIAS]
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters sharing a line and seperated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS

Optional The name of a specific alias to display.

Global Flags

--debug

Enables verbose output to the console.

For example:

mc --debug COMMAND
--config-dir

The path to a JSON formatted configuration file that mc uses for storing data. See Configuration File for more information on how mc uses the configuration file.

--JSON

Enables JSON lines formatted output to the console.

For example:

mc --JSON COMMAND
--no-color

Disables the built-in color theme for console output. Useful for dumb terminals.

--quiet

Suppresses console output.

--insecure

Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts.

--version

Displays the current version of mc.

--help

Displays a summary of command usage on the terminal.

Examples

List All Configured Aliases

The following mc alias list command lists all configured aliases in the local mc configuration.

mc alias list
mc alias list

List a Specific Alias

The following mc alias list command lists the details of a specific alias in the local mc configuration.

mc alias list myminio
mc alias list ALIAS
  • Replace ALIAS with the the name of the alias to return.

Behavior

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested MinIO and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While mc commands may work as documented, any such usage is at your own risk.