Skip to main content
To use MiniMax in Claude Code, Codex, or OpenCode, you do not need to find and edit each tool’s configuration first. Run the one-click setup wizard, choose your tools and service region, and the wizard verifies your API Key, offers to install compatible tools that are missing, and configures MiniMax M3. The following AI coding tools are currently supported:
  • Claude Code
  • Codex CLI
  • OpenCode
  • Grok CLI
  • Hermes Agent
  • Pi

​
Before you begin

Make sure you have:
  • Node.js 18 or newer, with npx available in your terminal
  • A valid MiniMax API Key
  • Network access to npm, MiniMax services, and the tools’ official download sources
Visit the Node.js website, then download and install the current LTS version.When installation finishes, reopen your terminal and run:
If both commands show a version number, the installation was successful.

​
Bring MiniMax into your coding workflow

1

Get an API Key

Token Plan keys (sk-cp-...) and pay-as-you-go keys (sk-api-...) use separate quotas. The wizard accepts both and asks you to select the key type.
2

Let the wizard handle setup

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

Return to your usual workflow

After setup succeeds, start the selected tool, such as claude, codex, or opencode. MiniMax M3 is now its default model.
Automatic installation supports macOS, Linux, and Windows. All tools except Pi currently require an arm64 or x64 system.
Claude Code
Codex CLI
Grok CLI
OpenCode
Pi
For Hermes Agent, mmx runs the non-interactive core CLI stages from the official installer and skips optional flows such as setup and gateway.

​
Bring setup into your scripts

Passing any command option switches the setup command to non-interactive mode. Non-interactive mode only writes configuration and does not install tools. You must specify the tools, API Key, and service region:
Configure every supported tool:
Preview the files that would change:
--dry-run does not make network requests, install tools, or write files. Available models are MiniMax-M3, MiniMax-M2.7, and MiniMax-M2.7-highspeed.

​
See which files the wizard changes

When writing configuration, the wizard:
  • Keeps settings unrelated to MiniMax
  • Creates a timestamped .bak backup before changing an existing file
  • Restricts configuration files to the current user, except on Windows
  • Restores files changed during the current run if a later write fails
Setup updates the MiniMax provider for each selected tool and changes its default model to the model you selected. Other providers and unrelated settings are preserved.

​
If something goes wrong

Make sure Node.js 18 or newer is installed, then run npx -y mmx-cli@latest agent setup again. If a local mmx command is outdated, you can use this npx command instead.
The wizard did not find the tool in the current terminal’s PATH. In interactive mode, it checks the installer requirements and asks whether to install each eligible tool.
The install list is skipped when the tool is already present, the command is running non-interactively, or the current environment does not meet the installer requirements. The wizard lists missing commands or unsupported architectures; Pi also requires Node.js 22.19 or newer.
The wizard shows the command and error. For npm permission errors with Codex, OpenCode, or Pi, see the npm documentation. You can also skip installation and continue writing the configuration.
Check for environment variables that override configuration files. Examples include ANTHROPIC_AUTH_TOKEN and ANTHROPIC_BASE_URL for Claude Code, or OPENAI_API_KEY and OPENAI_BASE_URL for Grok CLI.
If model_catalog_json in ~/.codex/config.toml points to a custom file, the wizard stops without changing any files. Keep the catalog and follow the manual Codex setup, or remove that setting and try again.