MiniMax-CLI 0.1.3__tar.gz → 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of MiniMax-CLI might be problematic. Click here for more details.

@@ -0,0 +1,202 @@
1
+ Metadata-Version: 2.4
2
+ Name: MiniMax-CLI
3
+ Version: 0.2.1
4
+ Summary: Unofficial MiniMax CLI - downloads and runs the Rust binary
5
+ Author: Hmbown
6
+ Project-URL: Homepage, https://github.com/Hmbown/MiniMax-CLI
7
+ Project-URL: Source, https://github.com/Hmbown/MiniMax-CLI
8
+ Keywords: minimax,cli,ai,agent
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: License :: OSI Approved :: MIT License
12
+ Classifier: Operating System :: OS Independent
13
+ Requires-Python: >=3.8
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Dynamic: license-file
17
+
18
+ # MiniMax CLI
19
+
20
+ [![CI](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml/badge.svg)](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml)
21
+ [![crates.io](https://img.shields.io/crates/v/minimax-cli)](https://crates.io/crates/minimax-cli)
22
+ [![npm](https://img.shields.io/npm/v/@hmbown/minimax-cli)](https://www.npmjs.com/package/@hmbown/minimax-cli)
23
+
24
+ Unofficial terminal UI (TUI) + CLI for the [MiniMax platform](https://platform.minimax.io): chat with **MiniMax-M2.1**, run an approval-gated tool-using agent, and generate media (images, video, music, TTS).
25
+
26
+ Not affiliated with MiniMax Inc.
27
+
28
+ ## Quickstart
29
+
30
+ 1. Get an API key from https://platform.minimax.io
31
+ 2. Install and run:
32
+
33
+ ```bash
34
+ npm install -g @hmbown/minimax-cli
35
+ export MINIMAX_API_KEY="YOUR_MINIMAX_API_KEY"
36
+ minimax
37
+ ```
38
+
39
+ 3. Press `F1` or run `/help` for the in-app command list
40
+ 4. If anything looks off, run `minimax doctor`
41
+
42
+ ## Install
43
+
44
+ ### Prebuilt via npm/bun (recommended)
45
+
46
+ The npm package is a thin wrapper that downloads the platform-appropriate Rust binary from GitHub Releases.
47
+
48
+ ```bash
49
+ # installs `minimax`
50
+ npm install -g @hmbown/minimax-cli
51
+ bun install -g @hmbown/minimax-cli
52
+ ```
53
+
54
+ ### From crates.io (Rust)
55
+
56
+ ```bash
57
+ cargo install minimax-cli --locked
58
+ ```
59
+
60
+ ### Build from source
61
+
62
+ ```bash
63
+ git clone https://github.com/Hmbown/MiniMax-CLI.git
64
+ cd MiniMax-CLI
65
+ cargo build --release
66
+ ./target/release/minimax --help
67
+ ```
68
+
69
+ ### Direct download
70
+
71
+ Download a prebuilt binary from https://github.com/Hmbown/MiniMax-CLI/releases and put it on your `PATH` as `minimax`.
72
+
73
+ ## Configuration
74
+
75
+ On first run, the TUI can prompt for your API key and save it to `~/.minimax/config.toml`. You can also create the file manually:
76
+
77
+ ```toml
78
+ # ~/.minimax/config.toml
79
+ api_key = "YOUR_MINIMAX_API_KEY" # must be non-empty
80
+ default_text_model = "MiniMax-M2.1" # optional
81
+ allow_shell = false # optional
82
+ max_subagents = 3 # optional (1-5)
83
+ ```
84
+
85
+ Useful environment variables:
86
+
87
+ - `MINIMAX_API_KEY` (overrides `api_key`)
88
+ - `MINIMAX_BASE_URL` (default: `https://api.minimax.io`; China users may use `https://api.minimaxi.com`)
89
+ - `MINIMAX_PROFILE` (selects `[profiles.<name>]` from the config; errors if missing)
90
+ - `MINIMAX_CONFIG_PATH` (override config path)
91
+ - `MINIMAX_MCP_CONFIG`, `MINIMAX_SKILLS_DIR`, `MINIMAX_NOTES_PATH`, `MINIMAX_MEMORY_PATH`, `MINIMAX_ALLOW_SHELL`, `MINIMAX_MAX_SUBAGENTS`
92
+
93
+ See `config.example.toml` and `docs/CONFIGURATION.md` for a full reference.
94
+
95
+ ## Modes
96
+
97
+ In the TUI, press `Tab` to cycle modes: **Normal → Plan → Agent → YOLO → RLM → Duo → Normal**.
98
+
99
+ - **Normal**: chat; asks before file writes, shell, or paid tools
100
+ - **Plan**: design-first prompting; same approvals as Normal
101
+ - **Agent**: multi-step tool use; asks before shell or paid tools
102
+ - **YOLO**: enables shell + trust + auto-approves all tools (dangerous)
103
+ - **RLM**: externalized context + REPL helpers; auto-approves tools (best for large files)
104
+ - **Duo**: player-coach autocoding with iterative validation (based on g3 paper)
105
+
106
+ Approval behavior is mode-dependent, but you can also override it at runtime with `/set approval_mode auto|suggest|never`.
107
+
108
+ ## Tools
109
+
110
+ MiniMax CLI exposes tools to the model: file read/write/patching, shell execution, web search, sub-agents, and MiniMax media APIs.
111
+
112
+ - **Workspace boundary**: file tools are restricted to `--workspace` unless you enable `/trust` (YOLO enables trust automatically).
113
+ - **Approvals**: the TUI requests approval depending on mode and tool category (file writes, shell, paid media).
114
+ - **Web search**: `web_search` uses DuckDuckGo HTML results and is auto-approved.
115
+ - **Media tools**: image/video/music/TTS tools make paid API calls and write real files.
116
+ - **Skills**: reusable workflows stored as `SKILL.md` directories (default: `~/.minimax/skills`). Use `/skills` and `/skill <name>` (this repo includes examples under `skills/`).
117
+ - **MCP**: load external tool servers via `~/.minimax/mcp.json` (supports `servers` and `mcpServers`). MCP tools currently execute without TUI approval prompts, so only enable servers you trust. See `docs/MCP.md`.
118
+
119
+ ## RLM
120
+
121
+ RLM mode is designed for “too big for context” tasks: large files, whole-doc sweeps, and big pasted blocks.
122
+
123
+ - Auto-switch triggers: “largest file”, explicit “RLM”, large file requests, and large pastes.
124
+ - In **RLM mode**, `/load @path` loads a file into the external context store (outside RLM mode, `/load` loads a saved chat JSON).
125
+ - Use `/repl` to enter expression mode (e.g. `search(\"pattern\")`, `lines(1, 80)`).
126
+ - Power tools: `rlm_load`, `rlm_exec`, `rlm_status`, `rlm_query`.
127
+
128
+ `rlm_query` can be expensive: prefer batching and check `/status` if you're doing lots of sub-queries.
129
+
130
+ ## Duo Mode
131
+
132
+ Duo mode implements the player-coach autocoding paradigm for iterative development with built-in validation:
133
+
134
+ - **Player**: implements requirements (builder role)
135
+ - **Coach**: validates implementation against requirements (critic role)
136
+ - Tools: `duo_init`, `duo_player`, `duo_coach`, `duo_advance`, `duo_status`
137
+
138
+ Workflow: `init → player → coach → advance → (repeat until approved)`
139
+
140
+ ## Examples
141
+
142
+ ```bash
143
+ minimax # Interactive TUI
144
+ minimax -p "Write a haiku" # One-shot prompt (prints and exits)
145
+
146
+ minimax doctor # Diagnose config + API key
147
+ minimax sessions --limit 50 # List sessions (~/.minimax/sessions)
148
+ minimax --resume latest # Resume most recent session
149
+ minimax --resume <id-prefix> # Resume by ID/prefix
150
+
151
+ minimax --workspace /path/to/project
152
+ minimax --yolo # Start in YOLO mode (dangerous)
153
+
154
+ minimax init # Generate a starter AGENTS.md
155
+ ```
156
+
157
+ Shell completions:
158
+
159
+ ```bash
160
+ minimax completions zsh > _minimax
161
+ minimax completions bash > minimax.bash
162
+ minimax completions fish > minimax.fish
163
+ ```
164
+
165
+ Run the paid media smoke test (writes real files and spends credits):
166
+
167
+ ```bash
168
+ minimax --workspace . smoke-media --confirm
169
+ ```
170
+
171
+ ## Troubleshooting
172
+
173
+ - **No API key**: set `MINIMAX_API_KEY` or run `minimax` and complete onboarding
174
+ - **Config not found**: check `~/.minimax/config.toml` (or `MINIMAX_CONFIG_PATH`)
175
+ - **Wrong region / base URL**: set `MINIMAX_BASE_URL` to `https://api.minimaxi.com` (China)
176
+ - **Session issues**: run `minimax sessions` and try `minimax --resume latest`
177
+ - **MCP tools missing**: validate `~/.minimax/mcp.json` (or `MINIMAX_MCP_CONFIG`) and restart
178
+
179
+ ## Documentation
180
+
181
+ - `docs/README.md`
182
+ - `docs/CONFIGURATION.md`
183
+ - `docs/MCP.md`
184
+ - `docs/ARCHITECTURE.md`
185
+ - `CONTRIBUTING.md`
186
+
187
+ ## Development
188
+
189
+ ```bash
190
+ cargo build
191
+ cargo test
192
+ cargo fmt
193
+ cargo clippy
194
+ ```
195
+
196
+ ## License
197
+
198
+ MIT
199
+
200
+ ---
201
+
202
+ MiniMax is a trademark of MiniMax Inc. This is an unofficial project.
@@ -0,0 +1,185 @@
1
+ # MiniMax CLI
2
+
3
+ [![CI](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml/badge.svg)](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml)
4
+ [![crates.io](https://img.shields.io/crates/v/minimax-cli)](https://crates.io/crates/minimax-cli)
5
+ [![npm](https://img.shields.io/npm/v/@hmbown/minimax-cli)](https://www.npmjs.com/package/@hmbown/minimax-cli)
6
+
7
+ Unofficial terminal UI (TUI) + CLI for the [MiniMax platform](https://platform.minimax.io): chat with **MiniMax-M2.1**, run an approval-gated tool-using agent, and generate media (images, video, music, TTS).
8
+
9
+ Not affiliated with MiniMax Inc.
10
+
11
+ ## Quickstart
12
+
13
+ 1. Get an API key from https://platform.minimax.io
14
+ 2. Install and run:
15
+
16
+ ```bash
17
+ npm install -g @hmbown/minimax-cli
18
+ export MINIMAX_API_KEY="YOUR_MINIMAX_API_KEY"
19
+ minimax
20
+ ```
21
+
22
+ 3. Press `F1` or run `/help` for the in-app command list
23
+ 4. If anything looks off, run `minimax doctor`
24
+
25
+ ## Install
26
+
27
+ ### Prebuilt via npm/bun (recommended)
28
+
29
+ The npm package is a thin wrapper that downloads the platform-appropriate Rust binary from GitHub Releases.
30
+
31
+ ```bash
32
+ # installs `minimax`
33
+ npm install -g @hmbown/minimax-cli
34
+ bun install -g @hmbown/minimax-cli
35
+ ```
36
+
37
+ ### From crates.io (Rust)
38
+
39
+ ```bash
40
+ cargo install minimax-cli --locked
41
+ ```
42
+
43
+ ### Build from source
44
+
45
+ ```bash
46
+ git clone https://github.com/Hmbown/MiniMax-CLI.git
47
+ cd MiniMax-CLI
48
+ cargo build --release
49
+ ./target/release/minimax --help
50
+ ```
51
+
52
+ ### Direct download
53
+
54
+ Download a prebuilt binary from https://github.com/Hmbown/MiniMax-CLI/releases and put it on your `PATH` as `minimax`.
55
+
56
+ ## Configuration
57
+
58
+ On first run, the TUI can prompt for your API key and save it to `~/.minimax/config.toml`. You can also create the file manually:
59
+
60
+ ```toml
61
+ # ~/.minimax/config.toml
62
+ api_key = "YOUR_MINIMAX_API_KEY" # must be non-empty
63
+ default_text_model = "MiniMax-M2.1" # optional
64
+ allow_shell = false # optional
65
+ max_subagents = 3 # optional (1-5)
66
+ ```
67
+
68
+ Useful environment variables:
69
+
70
+ - `MINIMAX_API_KEY` (overrides `api_key`)
71
+ - `MINIMAX_BASE_URL` (default: `https://api.minimax.io`; China users may use `https://api.minimaxi.com`)
72
+ - `MINIMAX_PROFILE` (selects `[profiles.<name>]` from the config; errors if missing)
73
+ - `MINIMAX_CONFIG_PATH` (override config path)
74
+ - `MINIMAX_MCP_CONFIG`, `MINIMAX_SKILLS_DIR`, `MINIMAX_NOTES_PATH`, `MINIMAX_MEMORY_PATH`, `MINIMAX_ALLOW_SHELL`, `MINIMAX_MAX_SUBAGENTS`
75
+
76
+ See `config.example.toml` and `docs/CONFIGURATION.md` for a full reference.
77
+
78
+ ## Modes
79
+
80
+ In the TUI, press `Tab` to cycle modes: **Normal → Plan → Agent → YOLO → RLM → Duo → Normal**.
81
+
82
+ - **Normal**: chat; asks before file writes, shell, or paid tools
83
+ - **Plan**: design-first prompting; same approvals as Normal
84
+ - **Agent**: multi-step tool use; asks before shell or paid tools
85
+ - **YOLO**: enables shell + trust + auto-approves all tools (dangerous)
86
+ - **RLM**: externalized context + REPL helpers; auto-approves tools (best for large files)
87
+ - **Duo**: player-coach autocoding with iterative validation (based on g3 paper)
88
+
89
+ Approval behavior is mode-dependent, but you can also override it at runtime with `/set approval_mode auto|suggest|never`.
90
+
91
+ ## Tools
92
+
93
+ MiniMax CLI exposes tools to the model: file read/write/patching, shell execution, web search, sub-agents, and MiniMax media APIs.
94
+
95
+ - **Workspace boundary**: file tools are restricted to `--workspace` unless you enable `/trust` (YOLO enables trust automatically).
96
+ - **Approvals**: the TUI requests approval depending on mode and tool category (file writes, shell, paid media).
97
+ - **Web search**: `web_search` uses DuckDuckGo HTML results and is auto-approved.
98
+ - **Media tools**: image/video/music/TTS tools make paid API calls and write real files.
99
+ - **Skills**: reusable workflows stored as `SKILL.md` directories (default: `~/.minimax/skills`). Use `/skills` and `/skill <name>` (this repo includes examples under `skills/`).
100
+ - **MCP**: load external tool servers via `~/.minimax/mcp.json` (supports `servers` and `mcpServers`). MCP tools currently execute without TUI approval prompts, so only enable servers you trust. See `docs/MCP.md`.
101
+
102
+ ## RLM
103
+
104
+ RLM mode is designed for “too big for context” tasks: large files, whole-doc sweeps, and big pasted blocks.
105
+
106
+ - Auto-switch triggers: “largest file”, explicit “RLM”, large file requests, and large pastes.
107
+ - In **RLM mode**, `/load @path` loads a file into the external context store (outside RLM mode, `/load` loads a saved chat JSON).
108
+ - Use `/repl` to enter expression mode (e.g. `search(\"pattern\")`, `lines(1, 80)`).
109
+ - Power tools: `rlm_load`, `rlm_exec`, `rlm_status`, `rlm_query`.
110
+
111
+ `rlm_query` can be expensive: prefer batching and check `/status` if you're doing lots of sub-queries.
112
+
113
+ ## Duo Mode
114
+
115
+ Duo mode implements the player-coach autocoding paradigm for iterative development with built-in validation:
116
+
117
+ - **Player**: implements requirements (builder role)
118
+ - **Coach**: validates implementation against requirements (critic role)
119
+ - Tools: `duo_init`, `duo_player`, `duo_coach`, `duo_advance`, `duo_status`
120
+
121
+ Workflow: `init → player → coach → advance → (repeat until approved)`
122
+
123
+ ## Examples
124
+
125
+ ```bash
126
+ minimax # Interactive TUI
127
+ minimax -p "Write a haiku" # One-shot prompt (prints and exits)
128
+
129
+ minimax doctor # Diagnose config + API key
130
+ minimax sessions --limit 50 # List sessions (~/.minimax/sessions)
131
+ minimax --resume latest # Resume most recent session
132
+ minimax --resume <id-prefix> # Resume by ID/prefix
133
+
134
+ minimax --workspace /path/to/project
135
+ minimax --yolo # Start in YOLO mode (dangerous)
136
+
137
+ minimax init # Generate a starter AGENTS.md
138
+ ```
139
+
140
+ Shell completions:
141
+
142
+ ```bash
143
+ minimax completions zsh > _minimax
144
+ minimax completions bash > minimax.bash
145
+ minimax completions fish > minimax.fish
146
+ ```
147
+
148
+ Run the paid media smoke test (writes real files and spends credits):
149
+
150
+ ```bash
151
+ minimax --workspace . smoke-media --confirm
152
+ ```
153
+
154
+ ## Troubleshooting
155
+
156
+ - **No API key**: set `MINIMAX_API_KEY` or run `minimax` and complete onboarding
157
+ - **Config not found**: check `~/.minimax/config.toml` (or `MINIMAX_CONFIG_PATH`)
158
+ - **Wrong region / base URL**: set `MINIMAX_BASE_URL` to `https://api.minimaxi.com` (China)
159
+ - **Session issues**: run `minimax sessions` and try `minimax --resume latest`
160
+ - **MCP tools missing**: validate `~/.minimax/mcp.json` (or `MINIMAX_MCP_CONFIG`) and restart
161
+
162
+ ## Documentation
163
+
164
+ - `docs/README.md`
165
+ - `docs/CONFIGURATION.md`
166
+ - `docs/MCP.md`
167
+ - `docs/ARCHITECTURE.md`
168
+ - `CONTRIBUTING.md`
169
+
170
+ ## Development
171
+
172
+ ```bash
173
+ cargo build
174
+ cargo test
175
+ cargo fmt
176
+ cargo clippy
177
+ ```
178
+
179
+ ## License
180
+
181
+ MIT
182
+
183
+ ---
184
+
185
+ MiniMax is a trademark of MiniMax Inc. This is an unofficial project.
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "MiniMax-CLI"
7
- version = "0.1.3"
7
+ version = "0.2.1"
8
8
  description = "Unofficial MiniMax CLI - downloads and runs the Rust binary"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.8"
@@ -0,0 +1,202 @@
1
+ Metadata-Version: 2.4
2
+ Name: MiniMax-CLI
3
+ Version: 0.2.1
4
+ Summary: Unofficial MiniMax CLI - downloads and runs the Rust binary
5
+ Author: Hmbown
6
+ Project-URL: Homepage, https://github.com/Hmbown/MiniMax-CLI
7
+ Project-URL: Source, https://github.com/Hmbown/MiniMax-CLI
8
+ Keywords: minimax,cli,ai,agent
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: License :: OSI Approved :: MIT License
12
+ Classifier: Operating System :: OS Independent
13
+ Requires-Python: >=3.8
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Dynamic: license-file
17
+
18
+ # MiniMax CLI
19
+
20
+ [![CI](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml/badge.svg)](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml)
21
+ [![crates.io](https://img.shields.io/crates/v/minimax-cli)](https://crates.io/crates/minimax-cli)
22
+ [![npm](https://img.shields.io/npm/v/@hmbown/minimax-cli)](https://www.npmjs.com/package/@hmbown/minimax-cli)
23
+
24
+ Unofficial terminal UI (TUI) + CLI for the [MiniMax platform](https://platform.minimax.io): chat with **MiniMax-M2.1**, run an approval-gated tool-using agent, and generate media (images, video, music, TTS).
25
+
26
+ Not affiliated with MiniMax Inc.
27
+
28
+ ## Quickstart
29
+
30
+ 1. Get an API key from https://platform.minimax.io
31
+ 2. Install and run:
32
+
33
+ ```bash
34
+ npm install -g @hmbown/minimax-cli
35
+ export MINIMAX_API_KEY="YOUR_MINIMAX_API_KEY"
36
+ minimax
37
+ ```
38
+
39
+ 3. Press `F1` or run `/help` for the in-app command list
40
+ 4. If anything looks off, run `minimax doctor`
41
+
42
+ ## Install
43
+
44
+ ### Prebuilt via npm/bun (recommended)
45
+
46
+ The npm package is a thin wrapper that downloads the platform-appropriate Rust binary from GitHub Releases.
47
+
48
+ ```bash
49
+ # installs `minimax`
50
+ npm install -g @hmbown/minimax-cli
51
+ bun install -g @hmbown/minimax-cli
52
+ ```
53
+
54
+ ### From crates.io (Rust)
55
+
56
+ ```bash
57
+ cargo install minimax-cli --locked
58
+ ```
59
+
60
+ ### Build from source
61
+
62
+ ```bash
63
+ git clone https://github.com/Hmbown/MiniMax-CLI.git
64
+ cd MiniMax-CLI
65
+ cargo build --release
66
+ ./target/release/minimax --help
67
+ ```
68
+
69
+ ### Direct download
70
+
71
+ Download a prebuilt binary from https://github.com/Hmbown/MiniMax-CLI/releases and put it on your `PATH` as `minimax`.
72
+
73
+ ## Configuration
74
+
75
+ On first run, the TUI can prompt for your API key and save it to `~/.minimax/config.toml`. You can also create the file manually:
76
+
77
+ ```toml
78
+ # ~/.minimax/config.toml
79
+ api_key = "YOUR_MINIMAX_API_KEY" # must be non-empty
80
+ default_text_model = "MiniMax-M2.1" # optional
81
+ allow_shell = false # optional
82
+ max_subagents = 3 # optional (1-5)
83
+ ```
84
+
85
+ Useful environment variables:
86
+
87
+ - `MINIMAX_API_KEY` (overrides `api_key`)
88
+ - `MINIMAX_BASE_URL` (default: `https://api.minimax.io`; China users may use `https://api.minimaxi.com`)
89
+ - `MINIMAX_PROFILE` (selects `[profiles.<name>]` from the config; errors if missing)
90
+ - `MINIMAX_CONFIG_PATH` (override config path)
91
+ - `MINIMAX_MCP_CONFIG`, `MINIMAX_SKILLS_DIR`, `MINIMAX_NOTES_PATH`, `MINIMAX_MEMORY_PATH`, `MINIMAX_ALLOW_SHELL`, `MINIMAX_MAX_SUBAGENTS`
92
+
93
+ See `config.example.toml` and `docs/CONFIGURATION.md` for a full reference.
94
+
95
+ ## Modes
96
+
97
+ In the TUI, press `Tab` to cycle modes: **Normal → Plan → Agent → YOLO → RLM → Duo → Normal**.
98
+
99
+ - **Normal**: chat; asks before file writes, shell, or paid tools
100
+ - **Plan**: design-first prompting; same approvals as Normal
101
+ - **Agent**: multi-step tool use; asks before shell or paid tools
102
+ - **YOLO**: enables shell + trust + auto-approves all tools (dangerous)
103
+ - **RLM**: externalized context + REPL helpers; auto-approves tools (best for large files)
104
+ - **Duo**: player-coach autocoding with iterative validation (based on g3 paper)
105
+
106
+ Approval behavior is mode-dependent, but you can also override it at runtime with `/set approval_mode auto|suggest|never`.
107
+
108
+ ## Tools
109
+
110
+ MiniMax CLI exposes tools to the model: file read/write/patching, shell execution, web search, sub-agents, and MiniMax media APIs.
111
+
112
+ - **Workspace boundary**: file tools are restricted to `--workspace` unless you enable `/trust` (YOLO enables trust automatically).
113
+ - **Approvals**: the TUI requests approval depending on mode and tool category (file writes, shell, paid media).
114
+ - **Web search**: `web_search` uses DuckDuckGo HTML results and is auto-approved.
115
+ - **Media tools**: image/video/music/TTS tools make paid API calls and write real files.
116
+ - **Skills**: reusable workflows stored as `SKILL.md` directories (default: `~/.minimax/skills`). Use `/skills` and `/skill <name>` (this repo includes examples under `skills/`).
117
+ - **MCP**: load external tool servers via `~/.minimax/mcp.json` (supports `servers` and `mcpServers`). MCP tools currently execute without TUI approval prompts, so only enable servers you trust. See `docs/MCP.md`.
118
+
119
+ ## RLM
120
+
121
+ RLM mode is designed for “too big for context” tasks: large files, whole-doc sweeps, and big pasted blocks.
122
+
123
+ - Auto-switch triggers: “largest file”, explicit “RLM”, large file requests, and large pastes.
124
+ - In **RLM mode**, `/load @path` loads a file into the external context store (outside RLM mode, `/load` loads a saved chat JSON).
125
+ - Use `/repl` to enter expression mode (e.g. `search(\"pattern\")`, `lines(1, 80)`).
126
+ - Power tools: `rlm_load`, `rlm_exec`, `rlm_status`, `rlm_query`.
127
+
128
+ `rlm_query` can be expensive: prefer batching and check `/status` if you're doing lots of sub-queries.
129
+
130
+ ## Duo Mode
131
+
132
+ Duo mode implements the player-coach autocoding paradigm for iterative development with built-in validation:
133
+
134
+ - **Player**: implements requirements (builder role)
135
+ - **Coach**: validates implementation against requirements (critic role)
136
+ - Tools: `duo_init`, `duo_player`, `duo_coach`, `duo_advance`, `duo_status`
137
+
138
+ Workflow: `init → player → coach → advance → (repeat until approved)`
139
+
140
+ ## Examples
141
+
142
+ ```bash
143
+ minimax # Interactive TUI
144
+ minimax -p "Write a haiku" # One-shot prompt (prints and exits)
145
+
146
+ minimax doctor # Diagnose config + API key
147
+ minimax sessions --limit 50 # List sessions (~/.minimax/sessions)
148
+ minimax --resume latest # Resume most recent session
149
+ minimax --resume <id-prefix> # Resume by ID/prefix
150
+
151
+ minimax --workspace /path/to/project
152
+ minimax --yolo # Start in YOLO mode (dangerous)
153
+
154
+ minimax init # Generate a starter AGENTS.md
155
+ ```
156
+
157
+ Shell completions:
158
+
159
+ ```bash
160
+ minimax completions zsh > _minimax
161
+ minimax completions bash > minimax.bash
162
+ minimax completions fish > minimax.fish
163
+ ```
164
+
165
+ Run the paid media smoke test (writes real files and spends credits):
166
+
167
+ ```bash
168
+ minimax --workspace . smoke-media --confirm
169
+ ```
170
+
171
+ ## Troubleshooting
172
+
173
+ - **No API key**: set `MINIMAX_API_KEY` or run `minimax` and complete onboarding
174
+ - **Config not found**: check `~/.minimax/config.toml` (or `MINIMAX_CONFIG_PATH`)
175
+ - **Wrong region / base URL**: set `MINIMAX_BASE_URL` to `https://api.minimaxi.com` (China)
176
+ - **Session issues**: run `minimax sessions` and try `minimax --resume latest`
177
+ - **MCP tools missing**: validate `~/.minimax/mcp.json` (or `MINIMAX_MCP_CONFIG`) and restart
178
+
179
+ ## Documentation
180
+
181
+ - `docs/README.md`
182
+ - `docs/CONFIGURATION.md`
183
+ - `docs/MCP.md`
184
+ - `docs/ARCHITECTURE.md`
185
+ - `CONTRIBUTING.md`
186
+
187
+ ## Development
188
+
189
+ ```bash
190
+ cargo build
191
+ cargo test
192
+ cargo fmt
193
+ cargo clippy
194
+ ```
195
+
196
+ ## License
197
+
198
+ MIT
199
+
200
+ ---
201
+
202
+ MiniMax is a trademark of MiniMax Inc. This is an unofficial project.
@@ -1,216 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: MiniMax-CLI
3
- Version: 0.1.3
4
- Summary: Unofficial MiniMax CLI - downloads and runs the Rust binary
5
- Author: Hmbown
6
- Project-URL: Homepage, https://github.com/Hmbown/MiniMax-CLI
7
- Project-URL: Source, https://github.com/Hmbown/MiniMax-CLI
8
- Keywords: minimax,cli,ai,agent
9
- Classifier: Development Status :: 3 - Alpha
10
- Classifier: Programming Language :: Python :: 3
11
- Classifier: License :: OSI Approved :: MIT License
12
- Classifier: Operating System :: OS Independent
13
- Requires-Python: >=3.8
14
- Description-Content-Type: text/markdown
15
- License-File: LICENSE
16
- Dynamic: license-file
17
-
18
- # MiniMax CLI
19
-
20
- ![CI](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml/badge.svg)
21
- ![crates.io](https://img.shields.io/crates/v/minimax-cli)
22
- ![npm](https://img.shields.io/npm/v/@hmbown/minimax-cli)
23
- ![PyPI](https://img.shields.io/pypi/v/MiniMax-CLI)
24
-
25
- Unofficial terminal UI (TUI) + CLI for the [MiniMax platform](https://platform.minimax.io): chat with **MiniMax-M2.1**, run an approval-gated tool-using agent, and generate media (images, video, music, TTS).
26
-
27
- Highlights:
28
-
29
- - Streaming chat via MiniMax’s Anthropic-compatible API format
30
- - Tool-using agent with approvals + workspace sandbox
31
- - Built-in MiniMax media tools (image/video/music/TTS/voice) that save outputs to your workspace
32
- - Skills (`SKILL.md`) and external tools via MCP
33
- - Project-aware prompts via `AGENTS.md` (and `.claude/instructions.md` / `CLAUDE.md`)
34
-
35
- Not affiliated with MiniMax Inc.
36
-
37
- ## Quickstart
38
-
39
- 1. Get an API key from https://platform.minimax.io
40
- 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`
41
- 3. Press `F1` or run `/help` for the in-app command list
42
-
43
- ## Install
44
-
45
- ### Prebuilt (recommended)
46
-
47
- NPM and Python packages are thin wrappers that download the platform-appropriate Rust binary from GitHub Releases.
48
-
49
- ```bash
50
- # npm / bun (installs `minimax`)
51
- npm install -g @hmbown/minimax-cli
52
- bun install -g @hmbown/minimax-cli
53
-
54
- # pip / uv (installs `minimax-cli`)
55
- pip install MiniMax-CLI
56
- uv pip install MiniMax-CLI
57
- ```
58
-
59
- ### From source (Rust)
60
-
61
- ```bash
62
- cargo install minimax-cli
63
- ```
64
-
65
- ### Direct download
66
-
67
- Download a prebuilt binary from https://github.com/Hmbown/MiniMax-CLI/releases and put it on your `PATH` as `minimax`.
68
-
69
- ## Usage
70
-
71
- ```bash
72
- minimax # Interactive TUI
73
- minimax -p "Write a haiku" # One-shot prompt (prints and exits)
74
-
75
- minimax doctor # Diagnose config + API key
76
- minimax sessions # List auto-saved sessions (~/.minimax/sessions)
77
- minimax --resume <id> # Resume by ID/prefix (or "latest")
78
- minimax --continue # Resume most recent session
79
-
80
- minimax --workspace /path/to/project
81
- minimax --yolo # Start in Agent mode + auto-approve tools (dangerous)
82
-
83
- minimax init # Generate a starter AGENTS.md for the current directory
84
- ```
85
-
86
- If you installed via pip, run the same commands as `minimax-cli ...` (it downloads the `minimax` binary and then execs it).
87
-
88
- Shell completions:
89
-
90
- ```bash
91
- minimax completions zsh > _minimax
92
- minimax completions bash > minimax.bash
93
- minimax completions fish > minimax.fish
94
- ```
95
-
96
- ## Configuration
97
-
98
- The TUI can save your API key during onboarding. You can also create `~/.minimax/config.toml` manually.
99
-
100
- Minimal config:
101
-
102
- ```toml
103
- api_key = "YOUR_MINIMAX_API_KEY"
104
- default_text_model = "MiniMax-M2.1" # optional
105
- allow_shell = false # optional
106
- max_subagents = 3 # optional (1-5)
107
- ```
108
-
109
- Useful environment variables:
110
-
111
- - `MINIMAX_API_KEY` (overrides config)
112
- - `MINIMAX_BASE_URL` (default: `https://api.minimax.io`; China users may use `https://api.minimaxi.com`)
113
- - `MINIMAX_PROFILE` (selects `[profiles.<name>]` from config)
114
- - `MINIMAX_CONFIG_PATH` (override config file path)
115
- - `MINIMAX_ALLOW_SHELL`, `MINIMAX_SKILLS_DIR`, `MINIMAX_MCP_CONFIG`, `MINIMAX_NOTES_PATH`
116
-
117
- See `config.example.toml` for a fuller config reference.
118
-
119
- ## Project Instructions (AGENTS.md)
120
-
121
- 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.
122
-
123
- Create a starter file:
124
-
125
- - CLI: `minimax init`
126
- - In-app: `/init`
127
-
128
- ## What You Can Do In The TUI
129
-
130
- ### Modes
131
-
132
- Switch modes with `Tab` or `/mode`:
133
-
134
- - **Normal**: chat
135
- - **Edit**: file-focused assistance
136
- - **Agent**: multi-step tool use (with approvals)
137
- - **Plan**: design-first prompting
138
- - **RLM**: load/search/chunk large files in an in-app sandbox
139
-
140
- ### Slash Commands (high-signal)
141
-
142
- The built-in help (`F1` or `/help`) is always up to date. Common commands:
143
-
144
- | Command | What it does |
145
- |---|---|
146
- | `/mode [normal|edit|agent|plan|rlm]` | Switch modes |
147
- | `/model [name]` | View/set model name |
148
- | `/skills` | List skills |
149
- | `/skill <name>` | Activate a skill for your next message |
150
- | `/save [path]` | Save current chat to JSON |
151
- | `/load <path>` | Load chat JSON (or load a file into RLM context in RLM mode) |
152
- | `/export [path]` | Export transcript to Markdown |
153
- | `/yolo` | Switch to Agent mode + enable shell tool (still prompts for approval) |
154
- | `/trust` | Allow file access outside workspace |
155
- | `/tokens` | Token totals + metadata |
156
- | `/context` | Context usage estimate |
157
- | `/cost` | Pricing reference for paid tools |
158
- | `/subagents` | Show sub-agent status |
159
-
160
- ## Tools, Safety, And The Workspace Boundary
161
-
162
- 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:
163
-
164
- - **File writes**: `write_file`, `edit_file`, `apply_patch`
165
- - **Shell**: `exec_shell` (disabled unless `allow_shell=true` or `/yolo` or `--yolo`)
166
- - **Paid/Media**: `generate_image`, `generate_video`, `generate_music`, `tts`, voice tools, file upload/download
167
-
168
- The built-in `web_search` tool is backed by DuckDuckGo HTML results and is auto-approved.
169
-
170
- File tools are restricted to the `--workspace` directory unless you enable `/trust`.
171
-
172
- ## Media Generation (MiniMax APIs)
173
-
174
- 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.
175
-
176
- 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`.
177
-
178
- ## Skills
179
-
180
- Skills are reusable workflows stored as `SKILL.md` files inside a directory.
181
-
182
- - If your workspace contains `./skills/`, the TUI uses that.
183
- - Otherwise, it falls back to `~/.minimax/skills/`.
184
-
185
- Use `/skills` to list and `/skill <name>` to activate.
186
-
187
- This repo includes example skills like `video-studio`, `voiceover-studio`, `music-video-generator`, and `audiobook-studio` under `skills/`.
188
-
189
- ## MCP (External Tool Servers)
190
-
191
- MiniMax CLI can load additional tools via MCP (Model Context Protocol). Configure `~/.minimax/mcp.json` (supports `servers` and `mcpServers` keys), then restart the TUI.
192
-
193
- For Coding Plan MCP setup, see `docs/coding-plan-integration.md`.
194
-
195
- ## Documentation
196
-
197
- - `docs/ARCHITECTURE.md`
198
- - `docs/coding-plan-integration.md`
199
- - `CONTRIBUTING.md`
200
-
201
- ## Development
202
-
203
- ```bash
204
- cargo build
205
- cargo test
206
- cargo fmt
207
- cargo clippy
208
- ```
209
-
210
- ## License
211
-
212
- MIT
213
-
214
- ---
215
-
216
- MiniMax is a trademark of MiniMax Inc. This is an unofficial project.
@@ -1,199 +0,0 @@
1
- # MiniMax CLI
2
-
3
- ![CI](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml/badge.svg)
4
- ![crates.io](https://img.shields.io/crates/v/minimax-cli)
5
- ![npm](https://img.shields.io/npm/v/@hmbown/minimax-cli)
6
- ![PyPI](https://img.shields.io/pypi/v/MiniMax-CLI)
7
-
8
- Unofficial terminal UI (TUI) + CLI for the [MiniMax platform](https://platform.minimax.io): chat with **MiniMax-M2.1**, run an approval-gated tool-using agent, and generate media (images, video, music, TTS).
9
-
10
- Highlights:
11
-
12
- - Streaming chat via MiniMax’s Anthropic-compatible API format
13
- - Tool-using agent with approvals + workspace sandbox
14
- - Built-in MiniMax media tools (image/video/music/TTS/voice) that save outputs to your workspace
15
- - Skills (`SKILL.md`) and external tools via MCP
16
- - Project-aware prompts via `AGENTS.md` (and `.claude/instructions.md` / `CLAUDE.md`)
17
-
18
- Not affiliated with MiniMax Inc.
19
-
20
- ## Quickstart
21
-
22
- 1. Get an API key from https://platform.minimax.io
23
- 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`
24
- 3. Press `F1` or run `/help` for the in-app command list
25
-
26
- ## Install
27
-
28
- ### Prebuilt (recommended)
29
-
30
- NPM and Python packages are thin wrappers that download the platform-appropriate Rust binary from GitHub Releases.
31
-
32
- ```bash
33
- # npm / bun (installs `minimax`)
34
- npm install -g @hmbown/minimax-cli
35
- bun install -g @hmbown/minimax-cli
36
-
37
- # pip / uv (installs `minimax-cli`)
38
- pip install MiniMax-CLI
39
- uv pip install MiniMax-CLI
40
- ```
41
-
42
- ### From source (Rust)
43
-
44
- ```bash
45
- cargo install minimax-cli
46
- ```
47
-
48
- ### Direct download
49
-
50
- Download a prebuilt binary from https://github.com/Hmbown/MiniMax-CLI/releases and put it on your `PATH` as `minimax`.
51
-
52
- ## Usage
53
-
54
- ```bash
55
- minimax # Interactive TUI
56
- minimax -p "Write a haiku" # One-shot prompt (prints and exits)
57
-
58
- minimax doctor # Diagnose config + API key
59
- minimax sessions # List auto-saved sessions (~/.minimax/sessions)
60
- minimax --resume <id> # Resume by ID/prefix (or "latest")
61
- minimax --continue # Resume most recent session
62
-
63
- minimax --workspace /path/to/project
64
- minimax --yolo # Start in Agent mode + auto-approve tools (dangerous)
65
-
66
- minimax init # Generate a starter AGENTS.md for the current directory
67
- ```
68
-
69
- If you installed via pip, run the same commands as `minimax-cli ...` (it downloads the `minimax` binary and then execs it).
70
-
71
- Shell completions:
72
-
73
- ```bash
74
- minimax completions zsh > _minimax
75
- minimax completions bash > minimax.bash
76
- minimax completions fish > minimax.fish
77
- ```
78
-
79
- ## Configuration
80
-
81
- The TUI can save your API key during onboarding. You can also create `~/.minimax/config.toml` manually.
82
-
83
- Minimal config:
84
-
85
- ```toml
86
- api_key = "YOUR_MINIMAX_API_KEY"
87
- default_text_model = "MiniMax-M2.1" # optional
88
- allow_shell = false # optional
89
- max_subagents = 3 # optional (1-5)
90
- ```
91
-
92
- Useful environment variables:
93
-
94
- - `MINIMAX_API_KEY` (overrides config)
95
- - `MINIMAX_BASE_URL` (default: `https://api.minimax.io`; China users may use `https://api.minimaxi.com`)
96
- - `MINIMAX_PROFILE` (selects `[profiles.<name>]` from config)
97
- - `MINIMAX_CONFIG_PATH` (override config file path)
98
- - `MINIMAX_ALLOW_SHELL`, `MINIMAX_SKILLS_DIR`, `MINIMAX_MCP_CONFIG`, `MINIMAX_NOTES_PATH`
99
-
100
- See `config.example.toml` for a fuller config reference.
101
-
102
- ## Project Instructions (AGENTS.md)
103
-
104
- 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.
105
-
106
- Create a starter file:
107
-
108
- - CLI: `minimax init`
109
- - In-app: `/init`
110
-
111
- ## What You Can Do In The TUI
112
-
113
- ### Modes
114
-
115
- Switch modes with `Tab` or `/mode`:
116
-
117
- - **Normal**: chat
118
- - **Edit**: file-focused assistance
119
- - **Agent**: multi-step tool use (with approvals)
120
- - **Plan**: design-first prompting
121
- - **RLM**: load/search/chunk large files in an in-app sandbox
122
-
123
- ### Slash Commands (high-signal)
124
-
125
- The built-in help (`F1` or `/help`) is always up to date. Common commands:
126
-
127
- | Command | What it does |
128
- |---|---|
129
- | `/mode [normal|edit|agent|plan|rlm]` | Switch modes |
130
- | `/model [name]` | View/set model name |
131
- | `/skills` | List skills |
132
- | `/skill <name>` | Activate a skill for your next message |
133
- | `/save [path]` | Save current chat to JSON |
134
- | `/load <path>` | Load chat JSON (or load a file into RLM context in RLM mode) |
135
- | `/export [path]` | Export transcript to Markdown |
136
- | `/yolo` | Switch to Agent mode + enable shell tool (still prompts for approval) |
137
- | `/trust` | Allow file access outside workspace |
138
- | `/tokens` | Token totals + metadata |
139
- | `/context` | Context usage estimate |
140
- | `/cost` | Pricing reference for paid tools |
141
- | `/subagents` | Show sub-agent status |
142
-
143
- ## Tools, Safety, And The Workspace Boundary
144
-
145
- 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:
146
-
147
- - **File writes**: `write_file`, `edit_file`, `apply_patch`
148
- - **Shell**: `exec_shell` (disabled unless `allow_shell=true` or `/yolo` or `--yolo`)
149
- - **Paid/Media**: `generate_image`, `generate_video`, `generate_music`, `tts`, voice tools, file upload/download
150
-
151
- The built-in `web_search` tool is backed by DuckDuckGo HTML results and is auto-approved.
152
-
153
- File tools are restricted to the `--workspace` directory unless you enable `/trust`.
154
-
155
- ## Media Generation (MiniMax APIs)
156
-
157
- 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.
158
-
159
- 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`.
160
-
161
- ## Skills
162
-
163
- Skills are reusable workflows stored as `SKILL.md` files inside a directory.
164
-
165
- - If your workspace contains `./skills/`, the TUI uses that.
166
- - Otherwise, it falls back to `~/.minimax/skills/`.
167
-
168
- Use `/skills` to list and `/skill <name>` to activate.
169
-
170
- This repo includes example skills like `video-studio`, `voiceover-studio`, `music-video-generator`, and `audiobook-studio` under `skills/`.
171
-
172
- ## MCP (External Tool Servers)
173
-
174
- MiniMax CLI can load additional tools via MCP (Model Context Protocol). Configure `~/.minimax/mcp.json` (supports `servers` and `mcpServers` keys), then restart the TUI.
175
-
176
- For Coding Plan MCP setup, see `docs/coding-plan-integration.md`.
177
-
178
- ## Documentation
179
-
180
- - `docs/ARCHITECTURE.md`
181
- - `docs/coding-plan-integration.md`
182
- - `CONTRIBUTING.md`
183
-
184
- ## Development
185
-
186
- ```bash
187
- cargo build
188
- cargo test
189
- cargo fmt
190
- cargo clippy
191
- ```
192
-
193
- ## License
194
-
195
- MIT
196
-
197
- ---
198
-
199
- MiniMax is a trademark of MiniMax Inc. This is an unofficial project.
@@ -1,216 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: MiniMax-CLI
3
- Version: 0.1.3
4
- Summary: Unofficial MiniMax CLI - downloads and runs the Rust binary
5
- Author: Hmbown
6
- Project-URL: Homepage, https://github.com/Hmbown/MiniMax-CLI
7
- Project-URL: Source, https://github.com/Hmbown/MiniMax-CLI
8
- Keywords: minimax,cli,ai,agent
9
- Classifier: Development Status :: 3 - Alpha
10
- Classifier: Programming Language :: Python :: 3
11
- Classifier: License :: OSI Approved :: MIT License
12
- Classifier: Operating System :: OS Independent
13
- Requires-Python: >=3.8
14
- Description-Content-Type: text/markdown
15
- License-File: LICENSE
16
- Dynamic: license-file
17
-
18
- # MiniMax CLI
19
-
20
- ![CI](https://github.com/Hmbown/MiniMax-CLI/actions/workflows/ci.yml/badge.svg)
21
- ![crates.io](https://img.shields.io/crates/v/minimax-cli)
22
- ![npm](https://img.shields.io/npm/v/@hmbown/minimax-cli)
23
- ![PyPI](https://img.shields.io/pypi/v/MiniMax-CLI)
24
-
25
- Unofficial terminal UI (TUI) + CLI for the [MiniMax platform](https://platform.minimax.io): chat with **MiniMax-M2.1**, run an approval-gated tool-using agent, and generate media (images, video, music, TTS).
26
-
27
- Highlights:
28
-
29
- - Streaming chat via MiniMax’s Anthropic-compatible API format
30
- - Tool-using agent with approvals + workspace sandbox
31
- - Built-in MiniMax media tools (image/video/music/TTS/voice) that save outputs to your workspace
32
- - Skills (`SKILL.md`) and external tools via MCP
33
- - Project-aware prompts via `AGENTS.md` (and `.claude/instructions.md` / `CLAUDE.md`)
34
-
35
- Not affiliated with MiniMax Inc.
36
-
37
- ## Quickstart
38
-
39
- 1. Get an API key from https://platform.minimax.io
40
- 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`
41
- 3. Press `F1` or run `/help` for the in-app command list
42
-
43
- ## Install
44
-
45
- ### Prebuilt (recommended)
46
-
47
- NPM and Python packages are thin wrappers that download the platform-appropriate Rust binary from GitHub Releases.
48
-
49
- ```bash
50
- # npm / bun (installs `minimax`)
51
- npm install -g @hmbown/minimax-cli
52
- bun install -g @hmbown/minimax-cli
53
-
54
- # pip / uv (installs `minimax-cli`)
55
- pip install MiniMax-CLI
56
- uv pip install MiniMax-CLI
57
- ```
58
-
59
- ### From source (Rust)
60
-
61
- ```bash
62
- cargo install minimax-cli
63
- ```
64
-
65
- ### Direct download
66
-
67
- Download a prebuilt binary from https://github.com/Hmbown/MiniMax-CLI/releases and put it on your `PATH` as `minimax`.
68
-
69
- ## Usage
70
-
71
- ```bash
72
- minimax # Interactive TUI
73
- minimax -p "Write a haiku" # One-shot prompt (prints and exits)
74
-
75
- minimax doctor # Diagnose config + API key
76
- minimax sessions # List auto-saved sessions (~/.minimax/sessions)
77
- minimax --resume <id> # Resume by ID/prefix (or "latest")
78
- minimax --continue # Resume most recent session
79
-
80
- minimax --workspace /path/to/project
81
- minimax --yolo # Start in Agent mode + auto-approve tools (dangerous)
82
-
83
- minimax init # Generate a starter AGENTS.md for the current directory
84
- ```
85
-
86
- If you installed via pip, run the same commands as `minimax-cli ...` (it downloads the `minimax` binary and then execs it).
87
-
88
- Shell completions:
89
-
90
- ```bash
91
- minimax completions zsh > _minimax
92
- minimax completions bash > minimax.bash
93
- minimax completions fish > minimax.fish
94
- ```
95
-
96
- ## Configuration
97
-
98
- The TUI can save your API key during onboarding. You can also create `~/.minimax/config.toml` manually.
99
-
100
- Minimal config:
101
-
102
- ```toml
103
- api_key = "YOUR_MINIMAX_API_KEY"
104
- default_text_model = "MiniMax-M2.1" # optional
105
- allow_shell = false # optional
106
- max_subagents = 3 # optional (1-5)
107
- ```
108
-
109
- Useful environment variables:
110
-
111
- - `MINIMAX_API_KEY` (overrides config)
112
- - `MINIMAX_BASE_URL` (default: `https://api.minimax.io`; China users may use `https://api.minimaxi.com`)
113
- - `MINIMAX_PROFILE` (selects `[profiles.<name>]` from config)
114
- - `MINIMAX_CONFIG_PATH` (override config file path)
115
- - `MINIMAX_ALLOW_SHELL`, `MINIMAX_SKILLS_DIR`, `MINIMAX_MCP_CONFIG`, `MINIMAX_NOTES_PATH`
116
-
117
- See `config.example.toml` for a fuller config reference.
118
-
119
- ## Project Instructions (AGENTS.md)
120
-
121
- 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.
122
-
123
- Create a starter file:
124
-
125
- - CLI: `minimax init`
126
- - In-app: `/init`
127
-
128
- ## What You Can Do In The TUI
129
-
130
- ### Modes
131
-
132
- Switch modes with `Tab` or `/mode`:
133
-
134
- - **Normal**: chat
135
- - **Edit**: file-focused assistance
136
- - **Agent**: multi-step tool use (with approvals)
137
- - **Plan**: design-first prompting
138
- - **RLM**: load/search/chunk large files in an in-app sandbox
139
-
140
- ### Slash Commands (high-signal)
141
-
142
- The built-in help (`F1` or `/help`) is always up to date. Common commands:
143
-
144
- | Command | What it does |
145
- |---|---|
146
- | `/mode [normal|edit|agent|plan|rlm]` | Switch modes |
147
- | `/model [name]` | View/set model name |
148
- | `/skills` | List skills |
149
- | `/skill <name>` | Activate a skill for your next message |
150
- | `/save [path]` | Save current chat to JSON |
151
- | `/load <path>` | Load chat JSON (or load a file into RLM context in RLM mode) |
152
- | `/export [path]` | Export transcript to Markdown |
153
- | `/yolo` | Switch to Agent mode + enable shell tool (still prompts for approval) |
154
- | `/trust` | Allow file access outside workspace |
155
- | `/tokens` | Token totals + metadata |
156
- | `/context` | Context usage estimate |
157
- | `/cost` | Pricing reference for paid tools |
158
- | `/subagents` | Show sub-agent status |
159
-
160
- ## Tools, Safety, And The Workspace Boundary
161
-
162
- 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:
163
-
164
- - **File writes**: `write_file`, `edit_file`, `apply_patch`
165
- - **Shell**: `exec_shell` (disabled unless `allow_shell=true` or `/yolo` or `--yolo`)
166
- - **Paid/Media**: `generate_image`, `generate_video`, `generate_music`, `tts`, voice tools, file upload/download
167
-
168
- The built-in `web_search` tool is backed by DuckDuckGo HTML results and is auto-approved.
169
-
170
- File tools are restricted to the `--workspace` directory unless you enable `/trust`.
171
-
172
- ## Media Generation (MiniMax APIs)
173
-
174
- 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.
175
-
176
- 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`.
177
-
178
- ## Skills
179
-
180
- Skills are reusable workflows stored as `SKILL.md` files inside a directory.
181
-
182
- - If your workspace contains `./skills/`, the TUI uses that.
183
- - Otherwise, it falls back to `~/.minimax/skills/`.
184
-
185
- Use `/skills` to list and `/skill <name>` to activate.
186
-
187
- This repo includes example skills like `video-studio`, `voiceover-studio`, `music-video-generator`, and `audiobook-studio` under `skills/`.
188
-
189
- ## MCP (External Tool Servers)
190
-
191
- MiniMax CLI can load additional tools via MCP (Model Context Protocol). Configure `~/.minimax/mcp.json` (supports `servers` and `mcpServers` keys), then restart the TUI.
192
-
193
- For Coding Plan MCP setup, see `docs/coding-plan-integration.md`.
194
-
195
- ## Documentation
196
-
197
- - `docs/ARCHITECTURE.md`
198
- - `docs/coding-plan-integration.md`
199
- - `CONTRIBUTING.md`
200
-
201
- ## Development
202
-
203
- ```bash
204
- cargo build
205
- cargo test
206
- cargo fmt
207
- cargo clippy
208
- ```
209
-
210
- ## License
211
-
212
- MIT
213
-
214
- ---
215
-
216
- MiniMax is a trademark of MiniMax Inc. This is an unofficial project.
File without changes
File without changes