> ## 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 面向开发者工作流的终端入口。它与桌面客户端互为补充：客户端适合图形化任务管理和结果查看，CLI 更贴近代码仓库、终端、脚本、CI 与编辑器。

  ## 三种使用方式

  <CardGroup cols={3}>
    <Card title="交互式 TUI" icon="terminal">
      使用 `mcode` 在终端中探索代码、持续对话、审阅工具调用和管理 Session。
    </Card>

    <Card title="Headless" icon="play">
      使用 `mcode exec` 执行一次任务，并把结构化结果交给脚本、CI 或评测流程。
    </Card>

    <Card title="ACP" icon="plug">
      使用 `mcode acp` 通过标准输入输出接入支持 Agent Client Protocol
      的编辑器和客户端。
    </Card>
  </CardGroup>

  ## 交互式 TUI

  ### 从理解仓库开始

  MCode 会基于当前工作区读取项目规则、目录结构、相关实现和可用脚本。`mcode init .` 或 `/init` 可以分析仓库，并生成或更新 `AGENTS.md`，让项目约定随代码一起维护。

  一个典型任务会经历：

  <Steps>
    <Step title="理解上下文">
      阅读项目约定、相关实现和测试入口，确定真正的修改范围。
    </Step>

    <Step title="执行修改">
      使用文件、搜索和终端工具完成代码或文档变更；关键权限与选择由你确认。
    </Step>

    <Step title="验证结果">
      运行相关测试或检查，处理失败，并汇总改动、证据和剩余风险。
    </Step>
  </Steps>

  ### 核心能力

  | 能力                  | 说明                                                                   |
  | ------------------- | -------------------------------------------------------------------- |
  | Session             | 新建、搜索、恢复、分叉和归档任务；也可从命令行继续最近的工作                                       |
  | 文件与多模态输入            | 使用 `@` 引用文件或目录，使用 `Ctrl+V` 粘贴图片或视频文件                                 |
  | Plan Mode           | 先讨论并审阅方案，再决定是否进入实现；使用 `Shift+Tab` 或 `/plan` 切换                       |
  | 权限控制                | Ask、Auto、Full access 三种模式独立于 Plan Mode；使用 `Alt+M` 或 `/permission` 切换 |
  | Queue 与 Steer       | 任务运行时继续发送会排队；也可以用当前 Draft 指导正在执行的响应                                  |
  | Goal                | 使用 `/goal <目标>` 启动可持续推进、可暂停和可恢复的目标                                   |
  | Provider 与模型        | 使用 MiniMax 托管模型、MiniMax API Key 或兼容的自定义 Provider                     |
  | Skills、MCP 与 Plugin | 复用工程流程，连接团队工具与数据，并安装可控的 Agent Plugin                                 |
  | Transcript 与上下文     | 查看完整对话、工具详情、上下文预算与 Token 用量                                          |

  ## Headless：脚本与 CI

  `mcode exec` 不启动 TUI，适合自动化、批处理和可复现评测。

  ```bash theme={null}
  mcode exec "修复失败的测试"

  mcode exec \
    --cwd ./repo \
    --file error.log \
    --output-format json \
    "分析错误日志，修复问题并运行相关测试"
  ```

  常用参数：

  | 参数                              | 用途                                   |
  | ------------------------------- | ------------------------------------ |
  | `--cwd <path>`                  | 指定工作区目录                              |
  | `--file <path>`                 | 添加附件，可重复使用                           |
  | `--model <provider/model>`      | 仅为本次运行指定模型                           |
  | `--session <id>` / `--continue` | 在已有 Session 中运行                      |
  | `--permission <policy>`         | 使用 `ask`、`smart`、`full` 或 `off` 权限策略 |
  | `--timeout <duration>`          | 设置运行超时，例如 `30s` 或 `2m`               |
  | `--max-steps <count>`           | 限制 Assistant 步数                      |
  | `--output-format <format>`      | 输出 `text`、`json` 或 `stream-json`     |
  | `--output-schema <json>`        | 使用 JSON Schema 校验最终 JSON 结果          |

  机器输出写入 `stdout`，诊断信息写入 `stderr`。只有显式使用 `--input -` 时才会读取标准输入，避免 CI 意外等待输入。

  ## ACP：接入编辑器

  `mcode acp` 把 MCode 作为 ACP v1 Agent server 运行，通过 `stdin/stdout` 传输 NDJSON。它不需要额外启动 HTTP 服务，也不要求编辑器安装 MCode 专用插件。

  以 Zed 为例，在 External Agents 中添加：

  ```json theme={null}
  {
    "agent_servers": {
      "minimax-code": {
        "type": "custom",
        "command": "mcode",
        "args": ["acp"],
        "env": {}
      }
    }
  }
  ```

  接入后，Assistant 回复、Thinking、工具状态、文件位置和 Diff 可以投影到编辑器；权限确认、问题选择和取消也沿同一条 ACP 任务流处理。如果编辑器找不到 `mcode`，将 `command` 改为可执行文件的绝对路径。

  <Warning>
    `mcode acp` 的 `stdout` 只用于 ACP
    协议消息。不要直接向它输入自然语言，也不要让包装脚本把日志写入 `stdout`。
  </Warning>

  ## 命令概览

  | 命令                             | 用途                          |
  | ------------------------------ | --------------------------- |
  | `mcode [prompt]`               | 启动交互式 TUI，可直接提交第一条任务        |
  | `mcode init [directory]`       | 分析代码库并生成或更新 `AGENTS.md`     |
  | `mcode exec [prompt]`          | 执行一次 Headless 任务            |
  | `mcode acp`                    | 启动 ACP stdio server         |
  | `mcode login` / `mcode logout` | 管理 MiniMax 登录状态             |
  | `mcode provider`               | 查看或管理 Provider 与 API Key 路由 |
  | `mcode plugin`                 | 浏览和管理 Agent Plugin          |
  | `mcode update`                 | 检查并安装当前安装来源支持的更新            |

  使用 `mcode <command> --help` 查看当前版本的完整参数合同。

  ## 能力边界

  * CLI 不依赖 Electron 或桌面端 IPC。Browser、Computer Use 等宿主能力只有在运行环境显式提供时才能使用。
  * 图片显示、链接点击、系统剪贴板和快捷键最终受终端模拟器及其配置影响；图片粘贴优先使用 `Ctrl+V`。
  * TUI、Headless 与 ACP 面向不同交互场景。ACP 客户端只会看到协议当前明确支持的命令和输入类型。
</div>