> ## Documentation Index
> Fetch the complete documentation index at: https://agent.minimaxi.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 快速开始

> 安装 MiniMax Code CLI，登录账号并完成第一个终端任务。

MiniMax Code CLI 把 MiniMax Code 带进终端和代码仓库。你可以用交互式 TUI 处理复杂任务，也可以用 `mcode exec` 接入 Shell 和 CI。

## 先选入口

| 入口 | 命令 | 适合场景 |
| - | - | - |
| 交互式 TUI | `mcode [prompt]` | 探索仓库、持续对话、审阅修改和处理权限确认 |
| Headless | `mcode exec [prompt]` | Shell、CI、批处理和评测 |
| ACP | `mcode acp` | 接入支持 Agent Client Protocol 的编辑器或客户端 |

## 环境要求

手动安装 CLI 时，需要以下 Node.js 版本之一：

* Node.js `22.19.0` 及以上的 22.x 版本；
* Node.js 24、25 或 26。

一键安装器会在需要时准备兼容的 Node.js。Alpine / musl Linux 当前不在一键安装器支持范围内。

## 安装

### 官方安装器

安装器会安装最新版 CLI，不需要 `sudo` 或管理员权限：

> [tab] macOS / Linux / WSL
>
> ```bash theme={null}
> curl -fsSL https://filecdn.minimax.chat/public/install.sh | bash
> ```

> [tab] Windows
>
> 在 PowerShell 中运行：
>
> ```powershell theme={null}
> irm https://filecdn.minimax.chat/public/install.ps1 | iex
> ```

### npm 安装

如果机器已经有兼容的 Node.js，也可以手动安装：

```bash theme={null}
npm install -g @minimax-ai/code
```

安装完成后重新打开终端，并确认命令可用：

```bash theme={null}
mcode --version
mcode --help
```

## 登录

中国大陆账号：

```bash theme={null}
mcode login
```

Global 账号：

```bash theme={null}
mcode login --region global
```

登录会在浏览器中完成。回到终端后，在 TUI 中运行 `/status` 检查账号、模型和运行状态。退出登录：

```bash theme={null}
mcode logout
```

如果你使用自定义 Provider 或 MiniMax API Key，可以跳过 Token Plan，改用 [Provider 配置](https://agent.minimaxi.com/docs/cli/features.md)。

## 完成第一个任务

进入需要处理的项目目录：

```bash theme={null}
cd /path/to/your/project
mcode
```

启动时直接提交第一条任务：

```bash theme={null}
mcode "检查当前项目中失败的测试，修复后运行相关测试"
```

建议在任务中说明期望结果、修改边界和验证方式。MCode 会读取当前工作区的项目规则、相关实现和测试入口，再执行修改和验证。

首次接入仓库时，可以生成或更新项目指导：

```bash theme={null}
mcode init .
```

`init` 会分析目录结构、项目规则和可用脚本，并生成或更新 `AGENTS.md`。

## 继续已有 Session

```bash theme={null}
# 继续当前工作区最近的 Session
mcode --continue

# 打开 Session 管理器
mcode --session

# 打开指定 Session
mcode --session <session-id>
```

`--session`、`--continue` 和兼容别名 `--resume` 不能同时使用。TUI 内使用 `/sessions [query]` 搜索和管理 Session。

## TUI 的第一组操作

| 操作 | 用途 |
| - | - |
| `Enter` | 发送消息；任务运行中用于 steer 当前响应 |
| `Alt+Enter` | 任务运行中将后续消息加入 Queue |
| `Shift+Enter` | 在输入框中换行 |
| `@` | 引用工作区中的文件或目录 |
| `Ctrl+V` | 粘贴剪贴板中的图片或视频文件 |
| `Shift+Tab` | 切换 Plan Mode |
| `Alt+M` | 切换 Ask、Auto、Full access 权限模式 |
| `Esc` | 关闭当前面板，或中断正在运行的任务 |

输入 `/help` 查看当前版本完整的命令和快捷键。任务运行期间按 `Enter` 或使用 `/steer <message>` 调整当前响应，按 `Alt+Enter` 将后续任务加入 Queue。

## 下一步

> [card] [功能与配置](https://agent.minimaxi.com/docs/cli/features.md)
>
> 了解 TUI、Headless、ACP、Provider、Plugin 和完整命令参考。

> [card] [故障排查](https://agent.minimaxi.com/docs/cli/faq.md)
>
> 排查安装、登录、配置、自动化输出、Session 和终端兼容问题。