Connect to Pyrula Cloud

Pyrula Cloud is a hosted UI for watching and controlling runs. Connecting to it takes an install and an environment variable — there is no code to write and nothing to wire up.

1. Install the client

pip install pyrula-cloud-client

Or as an extra of the core package:

pip install 'pyrula[cloud]'

2. Set your API key

export PYRULA_CLOUD_API_KEY="your-key"

That is the whole setup. Run your workflows and agents exactly as before, and they will report to the cloud.

The runtime checks for the key at startup. If it is absent, nothing connects and everything keeps working locally — so the same code runs connected or not, and you can leave the package installed in environments that should not report.

Optional settings

You will not normally need these.

Variable	Effect
PYRULA_CLOUD_URL	Point at a different cloud endpoint. Defaults to the one your key encodes.
PYRULA_RUNTIME_NAME	Label this runtime in the UI. Defaults to a generated name.
PYRULA_RUNTIME_ID	Give the runtime a stable identity across restarts. Defaults to a fresh id per process.

If it does not connect

The key is set but the package is not installed. The runtime raises a configuration error at startup rather than starting up disconnected and leaving you to wonder why nothing appears. Install pyrula-cloud-client, or unset PYRULA_CLOUD_API_KEY.

Nothing appears in the UI and no error. The key is almost certainly not reaching the process — an unexported shell variable, or a container that was not passed the environment. Check it is visible where the runtime actually runs:

python -c "import os; print(bool(os.environ.get('PYRULA_CLOUD_API_KEY')))"