Skip to content

quickstart.md

Latest commit

 

History

History
107 lines (72 loc) · 2.43 KB

quickstart.md

File metadata and controls

107 lines (72 loc) · 2.43 KB
Raw

Quickstart

The dcd command line is intentionally designed to mimic the Maestro Cloud API. In most cases, you can just change maestro cloud to dcd cloud:

# maestro cloud --apiKey <apiKey> <appFile> <flowFile>

dcd cloud <appFile> <flowFile>

1. Install the CLI

The recommended install is the standalone binary — no Node required.

{% 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" %} Install Node 22+, then run:

npm install -g @devicecloud.dev/dcd

{% endtab %} {% endtabs %}

2. Authenticate

Log in once in your browser — the CLI remembers your session, so you don't need to pass a key on every command:

dcd login

Running in CI or a headless environment? Use an API key instead. Find it in the console settings page and set it as an environment variable:

export DEVICE_CLOUD_API_KEY=your-api-key

See Authentication for more detail.

3. Run your first flow

iOS

dcd cloud <appFile>.app <flowFile>

Android

dcd cloud <appFile>.apk <flowFile>

That's it! Questions? Issues? Head to our Discord.

Upgrading the CLI

If you installed the standalone binary:

dcd upgrade

If you installed via npm:

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

Prerelease versions (not recommended): Occasionally, prerelease versions are available under the alpha, beta, and rc tags, in increasing order of stability. See available versions on NPM.

npm install -g @devicecloud.dev/dcd@alpha
npm install -g @devicecloud.dev/dcd@beta
npm install -g @devicecloud.dev/dcd@rc

Limits

Every flow has a 10-minute execution limit after which it will be automatically cancelled.

Next steps