跳转到内容

CLI 概述

ml-cli 通过桌面客户端的 Local API 管理 MoreLogin,还提供客户端安装与启动、诊断、Agent 集成、自更新和 Shell 补全。

本文档按 CLI 源码 2.8.3、master 提交 efac10e 核对。源码变更日志将 2.8.x 标为 Unreleased,不代表下载服务已发布该版本;请先检查本机版本。

ml-cli --version
ml-cli --help
ml-cli self-update --dry-run

下载与安装

下载与操作系统、架构匹配的官方二进制文件:

平台架构下载
Windowsx64ml-cli.exe
macOSIntel x64ml-cli
macOSApple Silicon arm64ml-cli
Linuxx64ml-cli

macOS/Linux 下载后赋予可执行权限并放入 PATH。Windows 将 ml-cli.exe 所在目录加入用户 PATH,然后重开终端。这些操作安装的是 CLI;客户端安装是独立流程。

chmod +x ./ml-cli
sudo mv ./ml-cli /usr/local/bin/ml-cli
ml-cli --version
$cliDir = Join-Path $env:LOCALAPPDATA "MoreLogin\bin"
New-Item -ItemType Directory -Force -Path $cliDir
Copy-Item .\ml-cli.exe (Join-Path $cliDir "ml-cli.exe")
$userPath = [Environment]::GetEnvironmentVariable("Path", "User")
[Environment]::SetEnvironmentVariable("Path", "$userPath;$cliDir", "User")

Local API 命令需要 MoreLogin 桌面客户端已运行并登录。端口可自动发现,也可依次通过 --port、ML_PORT 指定。配置 Local API 安全密钥后,通过 --api-key 或 ML_API_KEY 提供;不要公开真实密钥。

功能与文档入口

资源命令组包括 env、cloud-browser、cloudphone(含团队应用)、group、tag、proxy、schedule、cloud-storage。快速开始介绍连接与输出,常用流程介绍资源操作,命令总表提供完整帮助树;另有 Agent 使用、客户端安装与启动。

退出码

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

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

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