跳转到内容
Last updated

快速开始

先检查版本和帮助,再检查正在运行的客户端。doctor --output-json 返回诊断报告,应同时查看字段和退出码。

ml-cli --version
ml-cli doctor --output-json
ml-cli status
ml-cli env list --page-no 1 --page-size 20
ml-cli cloudphone list --page-no 1 --page-size 20

认证与端口选择

需要登录时为 login 提供 API ID 和 API Key。Local API 配置的 Bearer 安全密钥在调用时另外提供。下列内容均为占位示例。端口优先级为 --port → ML_PORT → IPC 自动发现。

ml-cli login --api-id YOUR_API_ID --api-key YOUR_API_KEY
export ML_API_KEY="YOUR_LOCAL_API_KEY"
ml-cli --port 40000 env list
$env:ML_API_KEY = "YOUR_LOCAL_API_KEY"
ml-cli --port 40000 env list

JSON、输出与退出码

--json-data(别名 --json)提供基础 JSON 对象;显式 flags 覆盖同名字段,省略的 flags 保留 JSON 值。团队应用布尔参数必须显式传 true 或 false,false 不会丢失。必填字段以命令帮助为准。

ml-cli --format table env list
ml-cli --fail-on-business-error cloudphone info --id "$PHONE_ID"
ml-cli --verbose env list
ml-cli --quiet env list
ml-cli env list | jq ".data.dataList"

默认输出 JSON。--format table 提供便于阅读的视图;完整嵌套字段及管道处理应使用 JSON。--verbose 向 stderr 输出请求诊断信息,并遮盖已知敏感键;--quiet 抑制成功时的 stdout,两者不能同时使用。

  • 0:正常结束。API 调用在未启用严格检查时,即使 HTTP 2xx 也可能包含业务失败。

  • 1:启用 --fail-on-business-error 后检测到顶层非零业务 code,或操作不受支持(如 Linux 上的 env arrange)。

  • 2:参数或 JSON 非法、本地校验失败、端口/连接失败、HTTP 非 2xx 或输出错误。客户端命令的检测失败、严格完整性校验失败也可返回 2,应结合状态字段判断。

超时与排障

请求默认超时 15 秒;env core-download 默认 1810 秒。显式 --timeout 覆盖默认值。浏览器 start/open 建议 30 秒,云手机 open/power-on 使用 120 秒。

IPC 在 macOS/Linux 使用 /tmp/MoreLogin-cli,Windows 使用 \\.\pipe\MoreLogin-cli。遇到 connect EPERM 127.0.0.1:<port>,应先处理 AI 宿主的本地访问权限;不要重复启动,先查状态。超时意味着结果未知,重试写入前先读取状态。