cli
Generate text, images, video, speech, and music by MiniMax.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/minimax-ai--cli)HTML
<a href="/listings/minimax-ai--cli"><img src="/api/listings/minimax-ai--cli/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
# For AI agents (OpenClaw, Cursor, Claude Code, etc.): add skill to your agent npx skills add MiniMax-AI/cli -y -g # Or install CLI globally for terminal use npm install -g mmx-cli
> Requires [Node.js](https://nodejs.org) 18+
> **Requires a MiniMax Token Plan** — [Global](https://platform.minimax.io/subscribe/token-plan) · [CN](https://platform.minimaxi.com/subscribe/token-plan)
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 249 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- <img src="https://file.cdn.minimax.io/public/MMX-capabilities.png" alt="MiniMax" width="100%" />
- <p align="center">
- <strong>The official CLI for the MiniMax AI Platform</strong><br>
- Built for AI agents. Generate text, images, video, and speech — from any agent or terminal.
- </p>
- <p align="center">
- <a href="https://www.npmjs.com/package/mmx-cli"><img src="https://img.shields.io/npm/v/mmx-cli.svg" alt="npm version" /></a>
- <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT" /></a>
- <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg" alt="Node.js >= 18" /></a>
- </p>
- <p align="center">
- <a href="README_CN.md">中文文档</a> · <a href="https://platform.minimax.io">Global Platform</a> · <a href="https://platform.minimaxi.com">CN Platform</a> · <a href="https://platform.minimax.io/docs/token-plan/minimax-cli">Example</a>
- </p>
- ## Features
- - **Text** — Multi-turn chat, streaming, system prompts, JSON output
- - **Image** — Text-to-image with aspect ratio and batch controls
- - **Video** — Async video generation with progress tracking
- - **Speech** — TTS with 30+ voices, speed control, streaming playback; speech-to-text transcription (json, verbose_json, srt, vtt)
- - **Vision** — Image understanding and description
- - **Search** — Web search powered by MiniMax
- - **Dual Region** — Seamless Global (`api.minimax.io`) and CN (`api.minimaxi.com`) support
- <img src="https://file.cdn.minimax.io/public/MMX-CLI-help.png" alt="MiniMax" width="100%" />
- ## Install
- ```bash
- # For AI agents (OpenClaw, Cursor, Claude Code, etc.): add skill to your agent
- npx skills add MiniMax-AI/cli -y -g
- # Or install CLI globally for terminal use
- npm install -g mmx-cli
- ```
- > Requires [Node.js](https://nodejs.org) 18+
- > **Requires a MiniMax Token Plan** — [Global](https://platform.minimax.io/subscribe/token-plan) · [CN](https://platform.minimaxi.com/subscribe/token-plan)
- ## Quick Start
- ```bash
- # Authenticate (interactive — choose MiniMax OAuth or paste an API key)
- mmx auth login
- # Or non-interactive
- mmx auth login --api-key sk-xxxxx
- # Start creating
- mmx text chat --message "What is MiniMax?"
- mmx image "A cat in a spacesuit"
- mmx speech synthesize --text "Hello!" --out hello.mp3
- mmx speech transcribe --file meeting.mp3
- mmx video generate --prompt "Ocean waves at sunset"
- mmx search "MiniMax AI latest news"
- mmx vision photo.jpg
- mmx quota
- ```
- ## Releasing
- Maintainers publish releases by pushing a SemVer Git tag; the release workflow
- derives the npm package version from that tag. See [the release guide](docs/releasing.md).
- ## Commands
- ### `mmx text`
- `text chat` and `text repl` default to `MiniMax-M3.1-Flash`. An explicit `--model` or saved `default-text-model` takes precedence. It is available with Token Plan, MiniMax Code, and pay-as-you-go keys. See the [model guide](https://platform.minimax.io/docs/guides/text-generation#agent).
- ```bash
- mmx text chat --message "Write a poem"
- mmx text chat --model MiniMax-M3.1-Flash --message "Hello" --stream
- mmx text chat --system "You are a coding assistant" --message "Fizzbuzz in Go"
- mmx text chat --message "user:Hi" --message "assistant:Hey!" --message "How are you?"
- cat messages.json | mmx text chat --messages-file - --output json
- ```
- ### `mmx image`
- ```bash
- mmx image "A cat in a spacesuit"
- mmx image generate --prompt "A cat" --n 3 --aspect-ratio 16:9
- mmx image generate --prompt "Logo" --out-dir ./out/
- # MiniMax-H3-Image text-to-image
- mmx image generate --model MiniMax-H3-Image --prompt "An orange cat basking on a windowsill, warm afternoon light, film look" --aspect-ratio 16:9 --area 2K
- mmx image generate --model MiniMax-H3-Image --prompt "Minimal poster" --size 2720x1536 --output-format png --n 2
- # MiniMax-H3-Image image editing (1-16 reference images, numbered Picture 1, 2, ... in order)
- mmx image generate --model MiniMax-H3-Image --prompt "Replace the cat in Picture 1 with the Shiba Inu in Picture 2, keep the background" --image cat.jpg --image https://example.com/dog.png
- ```
- Without `--image`, MiniMax-H3-Image calls `/v1/images/generations` (text-to-image); with `--image` it calls `/v1/images/edits` (image editing). Choose one way to set the output size: `--size WIDTHxHEIGHT` (area 655,360–20,000,000 px, aspect ratio 1:3–3:1), or `--aspect-ratio` plus `--area 1K|2K|4K` (default 4K). `--no-prompt-enhance` turns off prompt enhancement for text-to-image and then requires `--size` or a concrete `--aspect-ratio`. A failed image (for example one that fails the content safety check) does not stop the others; files keep their original position in the name and failures are reported on stderr (even with `--quiet`). With `--response-format base64`, the total output area (`n` × width × height) is limited to 20,000,000 px for png and 80,000,000 px for jpg/webp; with `size auto` each image counts as its `--area` level (4K = 4096 × 4096). Requests over the limit are rejected locally.
- The H3-Image endpoints are not idempotent, so a retry after a timeout generates and bills again. The CLI never retries them automatically and raises the timeout for these requests to at least 600 seconds, matching the server. `--seed`, `--prompt-optimizer`, and `--subject-ref` apply only to image-01.
- ### `mmx video`
- ```bash
- # Hailuo-2.3 (Video Generation V1)
- mmx video generate --prompt "Ocean waves at sunset" --download sunset.mp4
- mmx video generate --prompt "A robot painting" --async
- # MiniMax-H3 (Video Generation V2)
- mmx video generate --api-key "$MINIMAX_API_KEY" --model MiniMax-H3 --prompt "Ocean waves at sunset"
- mmx video generate --api-key "$MINIMAX_API_KEY" --model MiniMax-H3 --prompt "The subject walks forward" --image start.jpg
- mmx video generate --api-key "$MINIMAX_API_KEY" --model MiniMax-H3 --prompt "Keep the same character" --reference-image character.png --reference-video motion.mp4
- mmx video task get --task-id 123456
- mmx video task get --task-id 424010985738629 --model MiniMax-H3
- mmx video download --file-id 176844028768320 --out video.mp4
- ```
- For MiniMax-H3, local files and Base64 data URIs are preflight-checked against the documented limits: image 30 MB, reference video 50 MB, reference audio 15 MB, and total JSON request body 64 MB. The API validates dimensions, aspect ratio, duration, frame rate, and codecs for all media.
- `--region` is an existing global CLI option, not an H3 parameter. Normal video generation does not need it; the CLI uses the saved or automatically detected region. H3 defaults to 2K, 5 seconds, and 16:9 for text-to-video. Use `--resolution 768P` for 768P output.
- ### `mmx speech`
- ```bash
- mmx speech synthesize --text "Hello!" --out hello.mp3
- mmx speech synthesize --text "Stream me" --stream | mpv -
- mmx speech synthesize --text "Hi" --voice English_magnetic_voiced_man --speed 1.2
- echo "Breaking news" | mmx speech synthesize --text-file - --out news.mp3
- mmx speech voices
- ```
- ```bash
- # Speech-to-text (asr-1.0)
- mmx speech transcribe --file meeting.mp3
- mmx speech transcribe --file call.mp3 --language zh
- mmx speech transcribe --file talk.mp3 --response-format verbose_json --output json
- mmx speech transcribe --file talk.mp3 --response-format srt --out talk.srt
- mmx speech transcribe --file long.mp3 --stream
- ```
- `mmx speech transcribe` accepts wav, aiff, flac, m4a, mp3, aac, opus, and ogg files up to
- 50 MB and 500 seconds. Audio above 50 MB is rejected locally before upload; the 500 second
- limit is enforced by the API. Omitting `--language` enables mixed-language recognition.
- `--response-format json` (default) prints the transcript, `verbose_json` adds speakers and
- per-segment timestamps, and `srt` / `vtt` return subtitle documents. `n_speakers` and
- `segments` are part of the response, so pass `--output json` to see them. `--stream` prints
- incremental text and requires `json`; when stdout is not a terminal it accumulates into a single
- JSON result unless `--output text` is passed. `mmx speech recognize` is an alias for
- `mmx speech transcribe`.
- ### `mmx vision`
- ```bash
- mmx vision photo.jpg
- mmx vision describe --image https://example.com/img.jpg --prompt "What breed?"
- mmx vision describe --file-id file-123
- ```
- ### `mmx search`
- ```bash
- mmx search "MiniMax AI"
- mmx search query --q "latest news" --output json
- ```
- > The `/v1/coding_plan/search` API returns at most 10 results per call and does not currently expose a pagination parameter (see #107). Refine your query if you need different results.
- ### `mmx auth`
- ```bash
- mmx auth login # interactive: pick OAuth (Global / China) or paste an API key
- mmx auth login --api-key sk-xxxxx # save an API key directly
- mmx auth login --recommend # skip the menu, pick OAuth region interactively
- mmx auth login --recommend --region=global # OAuth → api.minimax.io
- mmx auth login --recommend --region=cn # OAuth → api.minimaxi.com
- mmx auth status
- mmx auth refresh
- mmx auth logout
- ```
- `mmx auth status` is the canonical way to verify active authentication.
- **OAuth** uses the [Device Authorization Grant (RFC 8628)](https://tools.ietf.org/html/rfc8628) with PKCE —
- the CLI opens your browser, you enter a code, and `access_token` + `refresh_token`
- are saved to `~/.mmx/config.json`. Tokens refresh automatically (5-min buffer);
- manual refresh via `mmx auth refresh`.
- **API key** auth auto-detects the correct region by probing both Global and CN.
- Useful for CI/CD (`mmx auth login --api-key sk-xxxxx`), or pass per-command via `--api-key`.
- OAuth and API key are mutually exclusive — logging in with one clears the other.
- Credential priority: `--api-key` flag > OAuth (config) > `api_key` (config).
- ### Environment variables
- | Variable | Description |
- |---|---|
- | `MINIMAX_REGION` | `global` or `cn`. |
- | `MINIMAX_BASE_URL` | Override the API base URL. |
- | `MINIMAX_OUTPUT` | `text` or `json`. |
- | `MINIMAX_TIMEOUT` | Request timeout in seconds. |
- | `MINIMAX_VERBOSE` | `1` to enable verbose HTTP logging. |
- | `MMX_CONFIG_DIR` | Directory containing the `config.json` file (default: `~/.mmx`). Set this when `mmx` runs from a subprocess, service, or CI job whose home directory differs from where you logged in. |
- ### `mmx config` · `mmx quota`
- ```bash
- mmx quota
- mmx config show
- mmx config set --key region --value cn
- mmx config set --key default-text-model --value MiniMax-M3.1-Flash
- mmx config export-schema | jq .
- ```
- ### `mmx agent setup`
- Configure MiniMax for Claude Code, Codex, Grok Build, OpenCode, Hermes, Pi, [Oh my Pi](https://github.com/can1357/oh-my-pi), or Zed while preserving unrelated settings. Run without options for the interactive wizard; supplying options makes the command non-interactive and suitable for scripts.
- ```bash
- mmx agent setup
- mmx agent setup --agent codex --agent claude-code --api-key "$MINIMAX_API_KEY" --region global
- mmx agent setup --all --api-key "$MINIMAX_API_KEY" --region cn --output json
- mmx agent setup --agent oh-my-pi --api-key "$MINIMAX_API_KEY" --region global
- # --agent omp is an alias for --agent oh-my-pi
- ```
- `agent setup` defaults to `MiniMax-M3.1-Flash` for both Token Plan and pay-as-you-go keys (`sk-api-...`). In non-interactive mode, `--model` overrides this selection.
- The command verifies the key and selected region before writing. Existing files are backed up when changed; use `--dry-run` to preview without a live request. In the interactive wizard, compatible agents that are missing from `PATH` can be installed from a second multi-select list using their official packages or installer scripts. The Hermes install uses its official core CLI stages and skips optional system packages, Node workspace, browser, computer-use, setup, and gateway stages. After installation, mmx applies the MiniMax configuration while preserving installer settings. Agents that fail a platform or prerequisite check are explained and left configuration-only. Non-interactive invocations remain configuration-only, and the command never launches an agent.
- Oh my Pi uses its native `~/.omp/agent/models.yml` and `config.yml` (existing `.yaml` files are updated in place). Configuration honors `OMP_PROFILE` / `PI_PROFILE`, `PI_CONFIG_DIR`, and the default-profile `PI_CODING_AGENT_DIR` override. Run `omp` once to migrate legacy JSON-only configuration before using setup. Interactive installation uses the official prebuilt-binary installer, so it does not require Bun or npm.
- ### `mmx update`
- ```bash
- mmx update
- mmx update latest
- ```
- ## Thanks to
- <a href="https://github.com/MiniMax-AI/cli/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=MiniMax-AI/cli" />
- </a>
- ## License
- [MIT](LICENSE)
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.