Skip to content

Latest commit

 

History

History
100 lines (73 loc) · 3.42 KB

File metadata and controls

100 lines (73 loc) · 3.42 KB

CLI Reference

The DCD CLI is the primary way to interact with DeviceCloud from your terminal or CI/CD pipeline. It is a drop-in replacement for maestro cloud — in most cases you can swap maestro cloud for dcd cloud.

The CLI is published as @devicecloud.dev/dcd on npm and as a standalone binary. The same package also ships an MCP server so AI agents can drive DeviceCloud directly.

{% hint style="info" %} New in v5: browser-based dcd login (no more passing a key on every command), a standalone binary installer with dcd upgrade, interactive dcd live device sessions, and an MCP server. Existing API keys and dcd cloud usage continue to work unchanged. {% endhint %}

Installation

The recommended install is the standalone binary — it has no dependencies and doesn't require Node.

{% tabs %} {% tab title="macOS / Linux" %}

curl -fsSL https://get.devicecloud.dev/install.sh | sh

{% endtab %}

{% tab title="Windows" %}

irm https://get.devicecloud.dev/install.ps1 | iex

{% endtab %}

{% tab title="npm" %} Requires Node 22 or newer.

npm install -g @devicecloud.dev/dcd

{% endtab %} {% endtabs %}

In CI, you can skip a separate install step and run the CLI directly with npx:

npx --yes @devicecloud.dev/dcd@latest cloud <app-file> <flows-dir>

Upgrading

If you installed the standalone binary, update it in place:

dcd upgrade

If you installed via npm, upgrade with npm instead:

npm install -g @devicecloud.dev/dcd@latest

{% hint style="info" %} dcd upgrade is only for binary installs. Automatic upgrade is not yet supported on Windows — re-run the PowerShell installer to update. {% endhint %}

Authentication

There are two ways to authenticate. See Authentication for full detail.

  • dcd login (recommended for local use) — authenticate once in your browser. The CLI stores a session, so you don't have to pass a key on every command, and it unlocks live test updates.
  • API key (recommended for CI/headless) — set the DEVICE_CLOUD_API_KEY environment variable, or pass --api-key <key> on any command.
# Local: log in once
dcd login

# CI / headless: provide an API key
export DEVICE_CLOUD_API_KEY=your-api-key

When both are present, precedence is: --api-key flag → DEVICE_CLOUD_API_KEY env var → stored dcd login session.

Commands

Command Description
dcd cloud Upload an app and run Maestro flows on DeviceCloud
dcd upload Upload an app binary and get a reusable binary ID
dcd status Check the status of a test upload
dcd list List recent uploads for your organisation
dcd artifacts Download artifacts or reports for a completed run
dcd login Authenticate via your browser
dcd logout Clear the stored session
dcd whoami Show the logged-in user and active organisation
dcd switch-org Switch the active organisation
dcd live Start and interact with a live device session (beta)
dcd upgrade Upgrade the standalone binary in place

Getting Help

dcd --help
dcd cloud --help
dcd live --help