Skip to main content

Unofficial MiniMax CLI - downloads and runs the Rust binary

Project description

MiniMax CLI

CI crates.io npm PyPI

Unofficial terminal UI (TUI) + CLI for the MiniMax platform: chat with MiniMax-M2.1, run an approval-gated tool-using agent, and generate media (images, video, music, TTS).

Highlights:

  • Streaming chat via MiniMax’s Anthropic-compatible API format
  • Tool-using agent with approvals + workspace sandbox
  • Built-in MiniMax media tools (image/video/music/TTS/voice) that save outputs to your workspace
  • Skills (SKILL.md) and external tools via MCP
  • Project-aware prompts via AGENTS.md (and .claude/instructions.md / CLAUDE.md)

Not affiliated with MiniMax Inc.

Quickstart

  1. Get an API key from https://platform.minimax.io
  2. Run minimax (or minimax-cli if you installed via pip) and paste your key when prompted (saved to ~/.minimax/config.toml), or set MINIMAX_API_KEY
  3. Press F1 or run /help for the in-app command list

Install

Prebuilt (recommended)

NPM and Python packages are thin wrappers that download the platform-appropriate Rust binary from GitHub Releases.

# npm / bun (installs `minimax`)
npm install -g @hmbown/minimax-cli
bun install -g @hmbown/minimax-cli

# pip / uv (installs `minimax-cli`)
pip install MiniMax-CLI
uv pip install MiniMax-CLI

From source (Rust)

cargo install minimax-cli

Direct download

Download a prebuilt binary from https://github.com/Hmbown/MiniMax-CLI/releases and put it on your PATH as minimax.

Usage

minimax                     # Interactive TUI
minimax -p "Write a haiku"   # One-shot prompt (prints and exits)

minimax doctor               # Diagnose config + API key
minimax sessions             # List auto-saved sessions (~/.minimax/sessions)
minimax --resume <id>        # Resume by ID/prefix (or "latest")
minimax --continue           # Resume most recent session

minimax --workspace /path/to/project
minimax --yolo               # Start in Agent mode + auto-approve tools (dangerous)

minimax init                 # Generate a starter AGENTS.md for the current directory

If you installed via pip, run the same commands as minimax-cli ... (it downloads the minimax binary and then execs it).

Shell completions:

minimax completions zsh > _minimax
minimax completions bash > minimax.bash
minimax completions fish > minimax.fish

Configuration

The TUI can save your API key during onboarding. You can also create ~/.minimax/config.toml manually.

Minimal config:

api_key = "YOUR_MINIMAX_API_KEY"
default_text_model = "MiniMax-M2.1" # optional
allow_shell = false                # optional
max_subagents = 3                  # optional (1-5)

Useful environment variables:

  • MINIMAX_API_KEY (overrides config)
  • MINIMAX_BASE_URL (default: https://api.minimax.io; China users may use https://api.minimaxi.com)
  • MINIMAX_PROFILE (selects [profiles.<name>] from config)
  • MINIMAX_CONFIG_PATH (override config file path)
  • MINIMAX_ALLOW_SHELL, MINIMAX_SKILLS_DIR, MINIMAX_MCP_CONFIG, MINIMAX_NOTES_PATH

See config.example.toml for a fuller config reference.

Project Instructions (AGENTS.md)

If your workspace has an AGENTS.md, the TUI loads it into the system prompt automatically (and will also look in parent directories up to the git root). Use it to tell the agent how to work in your repo: commands, conventions, and guardrails.

Create a starter file:

  • CLI: minimax init
  • In-app: /init

What You Can Do In The TUI

Modes

Switch modes with Tab or /mode:

  • Normal: chat
  • Edit: file-focused assistance
  • Agent: multi-step tool use (with approvals)
  • Plan: design-first prompting
  • RLM: load/search/chunk large files in an in-app sandbox

Slash Commands (high-signal)

The built-in help (F1 or /help) is always up to date. Common commands:

Command What it does
`/mode [normal edit
/model [name] View/set model name
/skills List skills
/skill <name> Activate a skill for your next message
/save [path] Save current chat to JSON
/load <path> Load chat JSON (or load a file into RLM context in RLM mode)
/export [path] Export transcript to Markdown
/yolo Switch to Agent mode + enable shell tool (still prompts for approval)
/trust Allow file access outside workspace
/tokens Token totals + metadata
/context Context usage estimate
/cost Pricing reference for paid tools
/subagents Show sub-agent status

Tools, Safety, And The Workspace Boundary

MiniMax CLI exposes a tool set to the model (file read/write, patching, web search, sub-agents, and MiniMax media APIs). By default, the TUI asks before running tools with side effects:

  • File writes: write_file, edit_file, apply_patch
  • Shell: exec_shell (disabled unless allow_shell=true or /yolo or --yolo)
  • Paid/Media: generate_image, generate_video, generate_music, tts, voice tools, file upload/download

The built-in web_search tool is backed by DuckDuckGo HTML results and is auto-approved.

File tools are restricted to the --workspace directory unless you enable /trust.

Media Generation (MiniMax APIs)

MiniMax CLI includes first-class tools for MiniMax’s media endpoints. In practice: ask for an image/video/music/TTS and the assistant can generate it and save outputs into your workspace.

Built-in MiniMax tool names (for power users): generate_image, generate_video, query_video, generate_music, tts, analyze_image, voice_clone, voice_list, voice_delete, voice_design.

Skills

Skills are reusable workflows stored as SKILL.md files inside a directory.

  • If your workspace contains ./skills/, the TUI uses that.
  • Otherwise, it falls back to ~/.minimax/skills/.

Use /skills to list and /skill <name> to activate.

This repo includes example skills like video-studio, voiceover-studio, music-video-generator, and audiobook-studio under skills/.

MCP (External Tool Servers)

MiniMax CLI can load additional tools via MCP (Model Context Protocol). Configure ~/.minimax/mcp.json (supports servers and mcpServers keys), then restart the TUI.

For Coding Plan MCP setup, see docs/coding-plan-integration.md.

Documentation

  • docs/ARCHITECTURE.md
  • docs/coding-plan-integration.md
  • CONTRIBUTING.md

Development

cargo build
cargo test
cargo fmt
cargo clippy

License

MIT


MiniMax is a trademark of MiniMax Inc. This is an unofficial project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minimax_cli-0.1.3.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minimax_cli-0.1.3-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file minimax_cli-0.1.3.tar.gz.

File metadata

  • Download URL: minimax_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for minimax_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a4ac57730b49328fc4355e3efe80bc64d19478f75ca883533a6f1a779b510198
MD5 33fe313d8cc6f35c7050ba8e7830ff27
BLAKE2b-256 1ccbf17e82b0eec489b3602dbfb82644b5d1c12823ac6afb24f6eda40a44a405

See more details on using hashes here.

Provenance

The following attestation bundles were made for minimax_cli-0.1.3.tar.gz:

Publisher: publish.yml on Hmbown/MiniMax-CLI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file minimax_cli-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: minimax_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for minimax_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4a4ea4ce780336a8fa4f3bd957e83c774024b44a846842f40d3e50b1e66d14d2
MD5 b998c9a32c2c831c643e44d6b6418660
BLAKE2b-256 f60e66db632517a7cb554f7460286f8fc586798e80e12c838992a53619e00a01

See more details on using hashes here.

Provenance

The following attestation bundles were made for minimax_cli-0.1.3-py3-none-any.whl:

Publisher: publish.yml on Hmbown/MiniMax-CLI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page