AIStor Client

The AIStor Client (mc) is a drop-in replacement for the Open Source MinIO Client. AIStor mc has exclusive functionality intended to support licensed AIStor Server deployments.

mc has the following syntax:

mc [GLOBALFLAGS] COMMAND --help

See Command Quick Reference for a list of supported commands.

The AIStor Client releases separately from AIStor Server.

For best functionality and compatibility, use an client version released closest to the calendar date of your server release.

You can download the latest AIStor MinIO Client for your operating system from https://dl.min.io/aistor/mc/release/.

1. Install mc

   Install the mc command line tool onto the host machine. Click the tab that corresponds to the host machine operating system or environment:

   Linux

   64-bit Intel

   curl --progress-bar -L https://dl.min.io/client/mc/release/linux-amd64/mc \
   --create-dirs \
   -o $HOME/minio-binaries/mc
   
   chmod +x ~/minio-binaries/mc
   
   ~/minio-binaries/mc --help
   

   ARM64

   curl --progress-bar -L https://dl.min.io/client/mc/release/linux-arm64/mc \
   --create-dirs \
   -o ~/minio-binaries/mc
   
   chmod +x ~/minio-binaries/mc
   
   ~/minio-binaries/mc --help
   

   macOS

   curl --progress-bar -L https://dl.min.io/aistor/mc/release/darwin-arm64/mc \
   --create-dirs \
   -o ~/minio-binaries/mc
   
   chmod +x ~/minio-binaries/mc
   
   ~/minio-binaries/mc --help
   

   macOS typically blocks unsigned binaries from running. If the --help command fails, go to System Settings, then Privacy and Security. Scroll to the Security section and select Allow Anyway for the mc application.

   Windows

   Invoke-WebRequest https://dl.min.io/aistor/mc/release/windows-amd64/mc -OutFile C:\mc.exe
   C:\mc.exe --help
   

2. Create an Alias for the S3-Compatible Service

   Run the mc alias set command to add the hostname of your AIStor Server deployment. Each of the following tabs contains a provider-specific example:

   AIStor Server

   mc alias set myminio https://minioserver.example.net ACCESS_KEY SECRET_KEY
   

   AWS S3 Storage

   mc alias set myS3 https://s3.{your-region-code}.amazonaws.com/endpoint ACCESS_KEY SECRET_KEY
   

   Google Cloud Storage

   mc alias set myGCS https://storage.googleapis.com/endpoint ACCESS_KEY SECRET_KEY
   

3. Test the Connection

   Run the mc admin info command to test the connection to the newly added server:

   mc admin info myminio
   

   The command returns information on the S3 service if successful. If unsuccessful, check each of the following:

   • The host machine has connectivity to the S3 service URL (i.e. using ping or traceroute).
   • The specified ACCESSKEY and SECRETKEY correspond to a user on the S3 service. The user must have permission to perform actions on the service.

   For AIStor servers, see Access Management for more information on user access permissions. For other S3-compatible services, defer to the documentation for that service.

The following table lists all top-level mc commands (excluding mc admin):

mc uses a JSON formatted configuration file used for storing certain kinds of information, such as the aliases for each configured S3-compatible service.

For Linux and macOS, the default configuration file location is ~/.mc/config.json.

For Windows, mc attempts to construct a default file path by trying specific environment variables. If a variable is unset, mc moves to the next variable. If all attempts fail, mc returns an error. The following list describes each possible file path location in the order mc checks them:

1. HOME\.mc\config.json
2. USERPROFILE\.mc\config.json
3. HOMEDRIVE+HOMEPATH\.mc\config.json

You can use the --config-dir flag to specify the location of the config.json file.

The AIStor client stores certificates and Certificate Authorities (CAs) for deployments to the following paths:

Linux, macOS, and other Unix-like systems:

~/.mc/certs/ # certificates
~/.mc/certs/CAs/ # Certificate Authorities

Windows systems:

C:\Users\[username]\mc\certs\ # certificates
C:\Users\[username]\mc\certs\CAs\ # Certificate Authorities

When creating a new alias, the AIStor client fetches the peer certificate, computes the public key fingerprint, and asks the user whether to accept the deployment’s certificate. If you decide to trust the certificate, the AIStor client adds the certificate to the certificate authority path listed above.

Some commands and flags allow for pattern matching. When enabled, a pattern can include either of these wildcards for character replacement:

• * to represent a string of characters to match, either in the middle or end.
• ? to represent a single character.

For example, refer to the following for wildcard uses and their results.

All commands support the following global options. You can also define some of these options using Environment Variables.

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.

Alternatively, set the environment variable MC_CONFIG_DIR.

Alias -H

Add an additional custom HTTP header to the request in key:value format.

Enables verbose output to the console.

For example, the following operation adds verbose output to the mc ls command:

mc --debug ls play

Alternatively, set the environment variable MC_DEBUG.

Alias --dp

Disable the pager functionality of the AIStor client in the CLI. When used, output prints to raw STDOUT instead.

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

Alternatively, set the environment variable MC_INSECURE.

Enables JSON lines formatted output to the console.

For example, the following operation adds JSON Lines output to the mc ls command:

mc --json ls play

Alternatively, set the environment variable MC_JSON.

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

Alternatively, set the environment variable MC_NO_COLOR.

Suppresses console output.

Alternatively, set the environment variable MC_QUIET.

Creates a custom DNS mapping to resolve a HOST to a specified IP address.

Use the following syntax:

--resolve HOST[:PORT]=IP

For example:

mc alias set --resolve myminio.example.com:9000=192.168.188.118 'myminio' 'https://myminio.example.com:9000' 'miniouser' 'miniosecret'

Repeat the flag multiple times to add additional custom DNS mappings.

Displays the current version of mc.

Optional

Displays a summary of command usage on the terminal.