Environment Variables

Configure the `obs` CLI through `OBS_API_KEY`, `OBS_API_URL`, and friends. The path of least resistance for CI pipelines and AI agents.

You can configure the ObserveOne CLI globally using standard environment variables. This is especially useful for CI/CD pipelines, Docker containers, or autonomous AI agents.

OBS_API_KEY#

Bypasses the obs login configuration file and directly injects your authentication token.

export OBS_API_KEY="obs1_your_secure_api_key_here"

OBS_API_URL#

Overrides the default API base URL (useful for staging or self-hosted environments).

export OBS_API_URL="https://api.observeone.com/api"

The CLI only attaches your auth token to ObserveOne hosts. If OBS_API_URL (or --api-url) points anywhere other than observeone.com, a *.observeone.com subdomain, or a loopback address, the token is stripped from the request and a warning is printed to stderr. The request still runs, so a mistyped URL fails as unauthenticated instead of leaking your key to a third party. The same guard covers the live event stream used by wait commands.

OBS_JSON_OUTPUT#

Forces the CLI to output strict JsonEnvelope payloads for every command, silencing all human-readable UI elements. Identical to passing --json.

export OBS_JSON_OUTPUT="true"

OBS_VERBOSE#

Enables verbose output, including detailed API execution logs and stack traces on failure.

export OBS_VERBOSE="true"

OBS_SKIP_UPDATE_CHECK#

Disables npm update notifications (useful in CI/CD or deterministic runs).

export OBS_SKIP_UPDATE_CHECK="true"

Headless Provisioning Variables#

If you are running obs login --headless, the CLI expects these variables to securely mint a new API key without interactive browser prompts:

export OBS_EMAIL="[email protected]"
export OBS_PASSWORD="secure-password"
Was this page helpful?