Skip to content

CLI Overview

ml-cli manages MoreLogin through the desktop Local API. It also provides Client setup, diagnostics, Agent integration, updates and shell completions.

This reference was verified against CLI source 2.8.3, master commit efac10e. The source changelog marks 2.8.x as Unreleased; this does not guarantee that the download service already distributes it. Check your installed version first.

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

Download and Installation

Download the official binary for your operating system and architecture:

PlatformArchitectureDownload
Windowsx64ml-cli.exe
macOSIntel x64ml-cli
macOSApple Silicon arm64ml-cli
Linuxx64ml-cli

On macOS/Linux, make the downloaded file executable and place it on PATH. On Windows, place ml-cli.exe in a directory on the user PATH, then reopen the terminal. These commands install the CLI; Client setup is separate.

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 commands require a running, logged-in MoreLogin desktop client. The port is discovered automatically or selected with --port, then ML_PORT. If a Local API security key is configured, supply --api-key or ML_API_KEY. Never publish the real key.

Capabilities and Guides

Resource groups: env, cloud-browser, cloudphone (including team apps), group, tag, proxy, schedule, and cloud-storage. Quick Start covers connection and output; Workflows covers resources; Commands contains the complete help tree; Agent Usage and Client Setup cover supporting tools.

Exit Codes

  • 0: normal completion. For API calls, HTTP 2xx alone can still contain a business failure unless strict checking is enabled.

  • 1: a nonzero top-level business code with --fail-on-business-error, or an unsupported operation such as env arrange on Linux.

  • 2: invalid arguments or JSON, local validation, port/connection failures, HTTP non-2xx, or output errors. Client commands also use 2 for documented detection or strict-integrity failures; inspect their status fields.