> ## 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">
  本页列出当前 CLI 的公开命令。安装版本可能随着 Runtime 能力演进增加参数；运行 `mcode --help` 或 `mcode <command> --help` 获取本机的最终合同。

  ## 全局入口

  ```text theme={null}
  mcode [options] [prompt]
  ```

  | 参数 | 说明 |
  | - | - |
  | `--version` | 输出 CLI 版本 |
  | `--help` | 输出帮助 |
  | `--session [id]` | 打开指定 Session；省略 ID 时打开 Session 浏览器 |
  | `-c, --continue` | 继续当前工作区最近的 Session |
  | `--tui-mode <mode>` | `regular`（默认）或 `fullscreen` |
  | `[prompt]` | 启动 TUI 时直接提交的任务 |

  `--session`、`--continue` 和兼容参数 `--resume <id>` 不能组合使用。

  ## 任务与集成命令

  ### init

  ```text theme={null}
  mcode init [directory]
  ```

  分析代码库并生成或更新 `AGENTS.md`。目录默认为当前目录；命令会启动 TUI 执行初始化任务。

  ### exec

  ```text theme={null}
  mcode exec [options] [prompt]
  ```

  不启动 TUI，执行一次 Headless 任务。完整输入、输出、Schema 和退出码见 [Headless 与 CI](/docs/cli/automation)。

  从 0.4.7 起，普通任务支持 `--prompt-mode tui|coding|work`，默认 `tui`。用法和续跑限制见 [选择任务指令](/docs/cli/automation#选择任务指令)。

  ### acp

  ```text theme={null}
  mcode acp
  mcode acp login --region <region>
  ```

  通过 stdio 启动 Agent Client Protocol server。`region` 为 `cn` 或 `global`。

  ## 账号命令

  ```text theme={null}
  mcode login [--region <region>]
  mcode logout
  ```

  `--region` 可选 `cn` 或 `global`；省略时使用中国大陆账号区域。

  ## Provider 命令

  ```text theme={null}
  mcode provider
  mcode provider list [--json]
  mcode provider add [options]
  mcode provider remove <provider-id> --yes
  mcode provider test <provider-id> [options]
  mcode provider use <token-plan|api-key>
  mcode provider set-minimax-key [--api-key-env <name>]
  ```

  `provider add` 选项：

  | 参数 | 说明 |
  | - | - |
  | `--name <name>` | Provider 显示名称，必填 |
  | `--base-url <url>` | Provider API 基础 URL，必填 |
  | `--api-format <format>` | `anthropic-messages`、`openai-completions` 或 `openai-responses` |
  | `--model <id>` | 模型 ID，可重复传入，至少一个 |
  | `--api-key-env <name>` | 读取 API Key 的环境变量名 |
  | `--use` | 将第一个模型设为默认模型 |

  如果不传 `--api-key-env`，默认读取 `MCODE_PROVIDER_API_KEY`。详见 [配置与模型](/docs/cli/configuration)。

  ## Plugin 命令

  ```text theme={null}
  mcode plugin list [options]
  mcode plugin add <plugin[@marketplace]> [options]
  mcode plugin remove <plugin[@marketplace]> [options]
  mcode plugin enable <plugin[@marketplace]> [options]
  mcode plugin disable <plugin[@marketplace]> [options]
  mcode plugin marketplace list [--json]
  mcode plugin marketplace upgrade [--json]
  ```

  通用选项：

  | 参数 | 说明 |
  | - | - |
  | `-m, --marketplace <marketplace>` | `official` 或 `local` |
  | `--available` | `plugin list` 同时显示未安装项目 |
  | `--json` | 输出 JSON |

  ## 更新命令

  ```text theme={null}
  mcode update
  ```

  检查并安装当前安装来源支持的更新。更新完成后重新启动当前 MCode 进程。

  ## 退出码

  `mcode exec` 的稳定退出码：

  | 退出码 | 含义 |
  | -: | - |
  | `0` | 成功 |
  | `2` | 调用参数或输入错误 |
  | `3` | 配置错误 |
  | `4` | Runtime 或任务失败 |
  | `6` | 超时 |
  | `7` | 超过运行限制 |
  | `70` | 内部错误 |
  | `130` | 被取消 |
  | `141` | broken pipe |
</div>