MiniMax CLI

MiniMax CLI (the mmx command) is MiniMax’s official command-line tool. With an M Plan subscription, you can use MiniMax text, image, video, speech, vision, and web search capabilities directly in your terminal or let AI agents such as Claude Code and OpenClaw call them for you, with no code required. Available capabilities depend on your plan and CLI version. MiniMax CLI requires Node.js 18 or later.

How to install Node.js

Visit the Node.js website, then download and install the current LTS version. When installation finishes, reopen your terminal and run:

node --version
npx --version

If both commands show a version number, the installation was successful.

Install and configure

Install via an agent
Manual install

Send the prompt below to your AI agent to install the CLI and add the SKILL. Sign in yourself in the terminal; do not send your Subscription Key to the agent.

Please set up MiniMax CLI (https://github.com/MiniMax-AI/cli) for me:

Install globally: run `npm install -g mmx-cli`, then verify with `mmx --version`.
Sign in: ask me to run `mmx auth login` in my local terminal. Do not ask for, print, or store my key in this conversation.
After I confirm sign-in is complete, install the official SKILL: run `npx skills add MiniMax-AI/cli -y -g`.
Finally, run `mmx quota` to confirm my M Plan usage is shown.

Install MiniMax CLI

npm install -g mmx-cli

Replace sk-xxxxx with your Subscription Key:

mmx auth login --api-key sk-xxxxx

MiniMax CLI detects the service region from your key. After signing in, run mmx quota; if your M Plan usage is shown, setup is complete. If API calls return 401, see Troubleshooting.

Install the SKILL (optional)

To let AI agents call mmx, install the official SKILL so the agent knows how each command works:

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

The SKILL is linked into ~/.claude/skills/, ~/.openclaw/skills/, and similar directories, and takes effect after the agent restarts. Skip this step if you only use mmx in the terminal.

Examples

After installing the SKILL, you can ask your agent in plain language to use MiniMax CLI, or run the matching command in your terminal. Text

Ask your agent: Use MiniMax to write a four-line poem about AI
Terminal command: mmx text chat --message "Write a four-line poem about AI"

Video

Ask your agent: Generate a video: at sunset, a cat sits by the window looking into the distance
Terminal command: mmx video generate --prompt "At sunset, a cat sits by the window looking into the distance"

Speech

Ask your agent: Read in a gentle female voice: Welcome to MiniMax M Plan. With a subscription, your agent can generate video, speech, and images.
Terminal command: mmx speech synthesize --text "Welcome to MiniMax M Plan. With a subscription, your agent can generate video, speech, and images." --out voiceover.mp3

Image

Ask your agent: Generate a cyberpunk city night scene in 16:9
Terminal command: mmx image generate --prompt "Cyberpunk city night scene" --aspect-ratio 16:9

When 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.

CLI dashboard

Run mmx with no arguments to open the CLI dashboard, which shows the main commands, options, and usage. MiniMax CLI dashboard

resources: resource types you can call
flags: options supported by commands
usage: current plan usage
help: usage instructions

Command reference

Capability	Command	Description
Text	`mmx text chat`	Multi-turn chat, streaming output, system prompts, JSON output
Image	`mmx image generate`	Text-to-image with aspect ratio control and batch generation
Video	`mmx video generate`	Asynchronous video generation with task status and download
Speech	`mmx speech synthesize`	Text-to-speech with multiple voices and streaming
Vision	`mmx vision describe`	Image understanding from local files, URLs, or file IDs
Search	`mmx search query`	Web search

More management commands

Command	Purpose	Example
`mmx auth status / refresh / logout`	Show sign-in identity / refresh credentials / sign out	`mmx auth status`
`mmx config show / set`	View or change configuration (service 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 M Plan usage and remaining quota	`mmx quota`
`mmx update`	Show the current version and upgrade hint	`mmx update`

One-click setup wizard

The one-click setup wizard verifies your key, installs missing tools if you choose, and adds MiniMax to the configuration of the AI coding tools you select. It currently supports Claude Code, Codex CLI, OpenCode, Grok CLI, Hermes Agent, and Pi.

Configure with the wizard

Get your Subscription Key

Get your Subscription Key from Plan Details.The wizard also accepts pay-as-you-go API Keys. Subscription Keys (sk-cp-...) and pay-as-you-go API Keys (sk-api-...) are billed separately, and the wizard asks which type you are using.

Run the wizard

npx -y mmx-cli@latest agent setup

Select the tools to configure. If a selected tool is not detected on PATH, a second multi-select asks which tools to install. Then choose the service region and key type, and paste your key.After you confirm, the wizard verifies the key, then shows and runs the official package or installer script. It checks each installed tool before writing the MiniMax configuration. If installation fails, you can skip it and continue writing the configuration.

Start your tool

After setup succeeds, start the selected tool, such as claude, codex, or opencode, to use MiniMax models.

Automatic installation supports macOS, Linux, and Windows. All tools except Pi currently require an arm64 or x64 system.

View installer sources and commands

macOS / Linux
Windows

Claude Code

curl -fsSL https://claude.ai/install.sh | bash

Codex CLI

npm install -g @openai/codex

Grok CLI

curl -fsSL https://x.ai/cli/install.sh | bash

OpenCode

npm install -g opencode-ai

npm install -g --ignore-scripts --engine-strict @earendil-works/pi-coding-agent

For Hermes Agent, the wizard runs the non-interactive core CLI stages of the official installer and skips optional flows such as setup and gateway.

Claude Code

irm https://claude.ai/install.ps1 | iex

Codex CLI

npm install -g @openai/codex

Grok CLI

irm https://x.ai/cli/install.ps1 | iex

OpenCode

npm install -g opencode-ai

npm install -g --ignore-scripts --engine-strict @earendil-works/pi-coding-agent

For Hermes Agent, the wizard runs the non-interactive core CLI stages of the official PowerShell installer and skips Computer Use and other optional flows.

Non-interactive mode

Pass options after the npx command to run the wizard non-interactively, for example in scripts. Non-interactive mode only writes configuration and does not install tools. You must specify the tools, key, and service region:

npx -y mmx-cli@latest agent setup \
  --agent claude-code \
  --agent codex \
  --api-key "$MINIMAX_API_KEY" \
  --region global

Use --all to configure every supported tool. Add --dry-run to preview the files that would change; it does not make network requests, install tools, or write files.

Option	Description
`--agent <name>`	Select one tool; repeat to select more
`--all`	Select every supported tool
`--api-key <key>`	Subscription Key or pay-as-you-go API Key
`--region cn\|global`	Service region; use `global` for the overseas service
`--model <model>`	Default model to write
`--dry-run`	Preview only; do not verify the key or write files
`--output json`	Return JSON for scripts

Configuration files

Tool	Configuration files
Claude Code	`~/.claude/settings.json`
Codex	`~/.codex/config.toml`, `~/.codex/mmx-model-catalog.json`
Grok CLI	`~/.grok/config.toml`
OpenCode	`~/.config/opencode/opencode.json` or `opencode.jsonc`
Hermes Agent	`~/.hermes/config.yaml`, `~/.hermes/.env`
Pi	`~/.pi/agent/models.json`, `~/.pi/agent/settings.json`

When writing configuration, the wizard:

Updates only the MiniMax configuration of the selected tools and keeps other providers and unrelated settings
Creates a timestamped .bak backup before changing an existing file
Makes configuration files readable and writable only by the current user (except on Windows)
Restores the files it changed if any step fails

Troubleshooting

The agent setup command is missing

Make sure Node.js 18 or later is installed, then run npx -y mmx-cli@latest agent setup again. If your local mmx is outdated, you can use this npx command instead.

A tool shows not detected on PATH

The wizard did not find the tool in the current terminal’s PATH. In interactive mode, it checks the installation requirements and asks whether to install each eligible tool.

The installation choices do not appear

The install list does not appear when the tool is already installed, the wizard is running non-interactively, or the environment does not meet the installation requirements. The wizard lists missing commands or unsupported architectures; Pi also requires Node.js 22.19 or later.

Installation fails

The wizard shows the command it ran and the error. For npm permission errors with Codex, OpenCode, or Pi, see the npm documentation. You can also skip installation and continue writing the configuration.

The tool still connects to another service

Check for environment variables that override configuration files, such as ANTHROPIC_AUTH_TOKEN and ANTHROPIC_BASE_URL for Claude Code, or OPENAI_API_KEY and OPENAI_BASE_URL for Grok CLI.

Codex already uses a custom model catalog

If model_catalog_json in ~/.codex/config.toml points to a custom file, the wizard stops without changing any files. Keep the catalog and configure Codex manually, or remove that setting and try again.

Quick overview

Subscription management

Usage guides

Updates and announcements

Install and configure

Examples

CLI dashboard

Command reference

One-click setup wizard

Configure with the wizard

Non-interactive mode

Configuration files

Troubleshooting

​Install and configure

​Examples

​CLI dashboard

​Command reference

​One-click setup wizard

​Configure with the wizard

​Non-interactive mode

​Configuration files

​Troubleshooting

Install and configure

Examples

CLI dashboard

Command reference

One-click setup wizard

Configure with the wizard

Non-interactive mode

Configuration files

Troubleshooting