MiniMax CLI

For Token Plan users, no coding is required to call MiniMax text, image, video, speech, vision, and web-search capabilities from agents such as OpenClaw and Claude Code. Availability depends on the current plan and CLI version. If you still prefer direct API integration, see the API Documentation.

Install and configure the CLI

Install via an agent
Manual install

Copy the prompt below to your AI agent (OpenClaw, Claude Code, Cursor, MaxClaw, AutoClaw, KimiClaw, TRAE, OpenCode, etc.). It will guide you through installing the CLI, signing in, and adding the SKILL:

Please integrate MiniMax CLI (https://github.com/MiniMax-AI/cli) for me in three steps:

1. Install globally: run `npm install -g mmx-cli`, then verify with `mmx --version`
2. Sign in: run `mmx auth login --api-key sk-xxxxx` (replace sk-xxxxx with my actual key); the latest CLI auto-detects the service region from the API Key — if API calls return 401 later, fall back to `mmx config set --key region --value global|cn` to set it manually
3. Install the official SKILL (recommended, helps you call mmx more accurately afterwards): run `npx skills add MiniMax-AI/cli -y -g`

After that, run `mmx quota` to confirm my Token Plan balance.

Install mmx-cli

Run the following command to install globally:

npm install -g mmx-cli

Authenticate with your API Key (replace sk-xxxxx with your key):

mmx auth login --api-key sk-xxxxx

The latest mmx-cli auto-detects the service region based on the API Key, so manual region configuration is usually unnecessary.

The service region depends on whether you purchased the API service from the mainland China platform (cn, MiniMax China subscription) or the overseas platform (global, MiniMax international subscription).

If your API calls return 401 after login, region detection likely failed. Set it manually:

mmx config set --key region --value global   # Overseas Service
mmx config set --key region --value cn       # Mainland China Service

Run mmx auth status to confirm the active region matches the platform you purchased from.

Install the SKILL (optional, recommended for Agent users)

If you want Claude Code, OpenClaw, Cursor, or other AI Agents to call mmx, install the official SKILL.md so the Agent can make better decisions and skip flipping through --help:

npx skills add MiniMax-AI/cli -y -g

The SKILL is auto-symlinked into ~/.claude/skills/, ~/.openclaw/skills/, and similar Agent directories, and is recognized after the next Agent restart. Skip this step if you only use mmx directly in the terminal.

Use the CLI

Call via an agent
Manual commands

LanguageUse minimax to write a 4-line poem about AI

VideoGenerate a video: at sunset, a cat sits by the window looking into the distance

Speech

Read in a gentle female voice: Welcome to MiniMax Token Plan. After subscribing, your AI agent can generate video, speech, and images with multimodal capability.

ImageGenerate a cyberpunk city night scene in 16:9When no output option is specified, images are saved to the current working directory. Use --out for a single output path or --out-dir for batch output.

Languagemmx text chat --message "Write a 4-line poem about AI"

Videommx video generate --prompt "At sunset, a cat sits by the window looking into the distance"

Speech

mmx speech synthesize --text "Welcome to MiniMax Token Plan. After subscribing, your AI agent can generate video, speech, and images with multimodal capability." --out voiceover.mp3

Imagemmx image "Cyberpunk city night scene, 16:9"

CLI Dashboard

Run mmx in your terminal to open the CLI panel and quickly discover the main commands, flags, and usage info.

resources: available resource types
flags: supported options for commands
usage: remaining quota and usage overview
help: entry points for documentation

Capability overview

MMX-CLI provides a single command-line entry point across text, image, video, speech, vision understanding, and web search:

Capability	Basic command	Description
Language	`mmx text chat`	multi-turn chat, streaming output, system prompts, JSON output
Image	`mmx image generate`	text-to-image, aspect ratio controls, batch generation
Video	`mmx video generate`	async generation, task status, downloading
Speech	`mmx speech synthesize`	text-to-speech (TTS), multiple voices, streaming
Vision	`mmx vision describe`	image understanding from local files, URLs, or file IDs
Search	`mmx search query`	built-in web search

More operations commands

Command	Purpose	Typical example
`mmx auth status / refresh / logout`	Show login identity / refresh credentials / log out	`mmx auth status`
`mmx config show / set`	View or change configuration (region, default model, etc.)	`mmx config set --key region --value global`
`mmx agent setup`	Configure MiniMax in AI coding tools	`mmx agent setup`
`mmx quota`	View Token Plan usage and remaining quota	`mmx quota`
`mmx update`	Show the current version and upgrade hint	`mmx update`

Usage coverage

For Token Plan quota and usage bar behavior, see: Token Plan Pricing

FAQ

Where do I get an API Key?

Overseas (default): Subscribe to Token Plan on platform.minimax.io → API Key for the overseas service
Mainland China: Subscribe to Token Plan on platform.minimaxi.com → API Key for the mainland China service

mmx auth login usually auto-detects the service region from the API Key. If you still get 401, region detection likely failed — set it manually:

mmx config set --key region --value global    # Overseas plan
mmx config set --key region --value cn        # Mainland China plan

Then run mmx auth status to confirm the active region matches the platform you purchased from.

Token Plan

Use M3 in AI Coding Tools

MCP Guide

CLI Guide

Best Practices

Install and configure the CLI

Use the CLI

CLI Dashboard

Capability overview

Usage coverage

FAQ

Where do I get an API Key?

​Install and configure the CLI

​Use the CLI

​CLI Dashboard

​Capability overview

​Usage coverage

​FAQ

​Where do I get an API Key?

​Still getting 401 after login?

Install and configure the CLI

Use the CLI

CLI Dashboard

Capability overview

Usage coverage

FAQ

Where do I get an API Key?

Still getting 401 after login?