Munk AI logoMunk AI
安装
返回文档
接入方式

接入方式与主要入口

了解如何在 CLI、MCP、GUI 与 Local API 之间选择最合适的 Munk AI 入口。

Munk AI 提供多种入口，让你可以根据自己的工作方式使用同一个产品。

不确定时，先从 CLI 开始

对大多数开发者来说，CLI 是最好的起点。它最适合：

  • 本地直接试用
  • 第一次检查环境
  • 直接执行验证工作流
  • 在终端里验证一次代码改动

CLI 之所以适合作为第一入口，是因为它同时覆盖了三类最常见的事情：

  • 检查环境是否可用
  • 生成或执行测试计划
  • 针对代码改动发起一次验证

如果你刚开始接触 Munk AI，推荐按这个顺序尝试：

munk doctor
munk serve --host 127.0.0.1 --port 16888
munk verify change --request-file /path/to/verify-change.request.json --config /path/to/config.yaml --json

上面三步分别对应：

  • doctor：确认当前运行环境是否完整
  • serve：启动本地 Web UI 与 Local API
  • verify change：围绕一次代码改动直接生成验证结果，适合作为第一次“真正跑起来”的入口

CLI 里最常见的四类命令

如果你不想先记完整命令树，可以先掌握下面四组：

munk doctor
munk serve --host 127.0.0.1 --port 16888
munk verify change --request-file /path/to/verify-change.request.json --config /path/to/config.yaml --json
munk plan --app-id your.app.id --requirement-doc /path/to/PRD.md --technical-doc /path/to/TECHNICAL_DESIGN.md --config /path/to/config.yaml
munk run plan --app-id your.app.id --plan-id your-plan-id --package com.example.app --device-ref your-device-ref --config /path/to/config.yaml

可以这样理解：

  • doctor：检查环境
  • serve：进入本地页面与 GUI
  • plan / run plan：先生成正式测试资产，再执行已经确认的 plan
  • verify change：围绕一次代码改动做 review-first 验证

一个推荐的 CLI 起步路径

如果你只是想快速理解 Munk AI，通常可以这样走：

  1. 先跑 munk doctor
  2. 再跑 munk serve
  3. 如果你在验证代码改动，优先用 munk verify change
  4. 如果你在做需求级测试资产管理，先用 munk plan，再用 munk run plan

这条路径的好处是：

  • 从最容易成功的命令开始
  • 不需要一开始就理解全部命令树
  • 可以先建立“环境 -> 计划 -> 执行 -> 报告”的整体心智模型

设备参数怎么指定

当前 CLI 执行相关命令统一使用跨平台参数 --device-ref，而不是旧的 Android-only serial 口径。

例如：

munk run case \
  --app-id your.app.id \
  --plan-id your-plan-id \
  --case-id your-case-id \
  --package com.example.app \
  --device-ref your-device-ref \
  --config /path/to/config.yaml

如果你不确定当前可选设备，可以先查看设备列表：

munk devices list --json

什么时候继续用 CLI，什么时候换入口

对大多数开发者来说，CLI 应该持续作为默认入口，尤其适用于：

  • 本地调试一次执行链
  • 在终端触发一次验证
  • 在 CI 或脚本中串接调用
  • 快速查看 operation、artifact 与设备信息

如果是 Agent 驱动工作流，使用 MCP

当你希望 Munk AI 作为 Coding Agent 或 Assistant 的工具面时，MCP 是更合适的入口。这在 Agent 需要把验证作为实现闭环一部分时尤其有用。

如果你需要 HTTP 集成，使用 Local API

当你希望把 Munk AI 接到本地服务、自动化包装层，或其他通过 HTTP 通讯的内部工具时，Local API 更合适。

如果你需要录制和观察，使用 GUI

当你希望在浏览器里做本地录制、观察和实时交互时，GUI 是最合适的入口。通常你会先运行：

munk serve --host 127.0.0.1 --port 16888

然后在浏览器中打开本地页面。

一个简单选择规则

可以直接按这个顺序判断：

  • 直接本地使用：先选 CLI
  • Agent 驱动：选 MCP
  • 需要 HTTP 集成：选 Local API
  • 需要录制和本地观察：选 GUI

如果你想查看完整 CLI 命令树、参数与更多示例，请继续阅读 CLI reference 文档。