> ## 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 并开始第一个命令行任务。

<div className="code-docs">
  MiniMax Code CLI 把 MiniMax Code 带进终端和代码仓库。本页从一键安装开始，带你登录账号、启动交互式 TUI，并完成第一个任务。

  ## 一键安装

  安装器会优先复用兼容的 Node.js；本机没有兼容版本时，会在用户目录中安装独立运行时。整个过程不需要 `sudo` 或管理员权限。

  <Tabs>
    <Tab title="macOS / Linux / WSL">
      ```bash theme={null}
      curl -fsSL https://filecdn.minimax.chat/public/install.sh | bash
      ```
    </Tab>

    <Tab title="Windows">
      在 PowerShell 中运行：

      ```powershell theme={null}
      irm https://filecdn.minimax.chat/public/install.ps1 | iex
      ```
    </Tab>
  </Tabs>

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

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

  <Note>
    一键安装支持 macOS、Windows、常见 Linux 发行版和 WSL，暂不支持 Alpine / musl
    Linux。
  </Note>

  ## 登录

  使用 MiniMax 官方模型或 Token Plan 前，先完成账号登录：

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

  Global 账号使用：

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

  登录会在浏览器中完成。回到终端后，可以在 TUI 中运行 `/status` 检查账号、模型与运行状态。使用自定义 Provider 或 API Key 时，可以通过 `mcode provider` 配置模型来源。

  ## 启动第一个任务

  进入需要处理的项目目录，再启动交互式 TUI：

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

  也可以在启动时直接提交任务：

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

  第一次进入仓库时，可以先生成或更新项目指导：

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

  MCode 会读取目录结构、项目规则、相关实现和可用脚本，再围绕目标推进修改与验证。描述任务时，建议同时说明期望结果、修改边界和验证方式。

  ## 继续已有 Session

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

  # 打开 Session 管理器
  mcode --session

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

  TUI 内也可以使用 `/sessions [query]` 搜索、恢复和管理 Session。

  ## 常用交互

  | 操作              | 用途                              |
  | --------------- | ------------------------------- |
  | `Enter`         | 发送消息；任务运行中继续发送会加入等待队列           |
  | `Shift+Enter`   | 在输入框中换行                         |
  | `@`             | 引用工作区中的文件或目录                    |
  | `Ctrl+V`        | 粘贴剪贴板中的图片或视频文件                  |
  | `Shift+Tab`     | 在 Default 与 Plan Mode 之间切换      |
  | `Alt+M`         | 在 Ask、Auto、Full access 权限模式之间切换 |
  | `Ctrl+O`        | 展开或收起 Thinking、工具输出与 Diff       |
  | `Ctrl+T`        | 展开或收起完整 Todo 列表                 |
  | `PgUp` / `PgDn` | 浏览对话历史；`End` 返回最新位置             |
  | `Esc`           | 关闭当前面板，或中断正在运行的任务               |

  ## 常用 Slash 命令

  | 命令                  | 用途               |
  | ------------------- | ---------------- |
  | `/help`             | 查看当前版本支持的命令与快捷键  |
  | `/status`           | 查看账号、模型和运行状态     |
  | `/model`            | 选择模型             |
  | `/sessions [query]` | 搜索、恢复和管理 Session |
  | `/context`          | 查看上下文预算和来源       |
  | `/compact`          | 压缩较长的当前对话        |
  | `/new`              | 在当前项目中新建 Session |
  | `/init`             | 分析项目并生成或更新项目指导   |
  | `/quit`             | 退出 MCode         |

  <CardGroup cols={2}>
    <Card title="功能介绍" icon="terminal" href="/docs/cli/features">
      了解交互式 TUI、Headless、ACP、Provider、Skills、MCP 与 Plugin。
    </Card>

    <Card title="常见问题" icon="circle-help" href="/docs/cli/faq">
      排查安装、登录、PATH、终端兼容与自动化输出问题。
    </Card>
  </CardGroup>
</div>