Getting Started¶

Requirements¶

To use Analog Cloud you need a working Python installation in the range 3.11 – 3.14 and network reachability of the Analog Cloud deployment you intend to use (typically over HTTPS). We recommend uv for managing the install, though a venv-based workflow with pip works just as well.

Note: This setup guide is written for Linux and macOS. Since Python is the only requirement, Windows is fully supported as well, but the setup instructions vary depending on how Python is installed. On Windows we recommend using uv too.

Obtaining an API key¶

All Analog Cloud functionality is gated by an API key. Keys are issued manually by anabrid — contact anabrid to request one. Every key is associated with a display name and email, a subscription that determines hourly and daily rate limits per device class, and optionally a whitelist of devices you may use.

Storing the key¶

Store the key in the environment variable ANALOGCLOUD_API_KEY. Both the CLI and the Python client read it from there.

export ANALOGCLOUD_API_KEY="<your-api-key>"

Avoid committing the key into source code or shell history files. Use your shell's secret-store integration where available.

Installing `analogcli`¶

The production build of the CLI is distributed via PyPI:

uv pip install analogcli

The install pulls in everything required for both the CLI and the Python client (AnalogCloudClient, pybrid-computing, etc.). Running this single command gives you access to all publicly available packages for anabrid's software stack.

Configuring the base URL¶

The CLI defaults to https://redac.anabrid.com. Override it per invocation with -u/--base-url:

uv run analogcli --base-url https://analogcloud.example.com status

The Python client accepts the same value via its base_url= constructor argument (and defaults to the same URL). There is no environment variable for the base URL in the CLI itself; the example scripts in examples/ read ANALOGCLOUD_URL and pass it explicitly to AnalogCloudClient.

Verifying the install¶

uv run analogcli status

This command prints the deployment's domain, version, and uptime, followed by a table of registered devices with their availability and queue depth. A 403 indicates an invalid or disabled API key; a connection error indicates the base URL is wrong or the deployment is unreachable.

Updating the client¶

Re-run the install command with -U to upgrade to the latest published version:

uv pip install -U analogcli