Configuring OX CLI

Configure the OX CLI to match your environment and preferences. Use the CLI configuration commands to view or update settings, configure a custom OX API endpoint, enable or disable telemetry, or use environment variables to override configuration values.

View the current configuration

To display the current value of a configuration parameter, run:

ox-cli config get <parameter>

To list all available configuration parameters, run:

ox-cli config get

Configure the OX API endpoint

By default, the OX CLI connects to the OX Cloud API endpoint.

If you're connecting to a different environment, such as a staging or development environment, configure a custom API endpoint:

ox-cli config set api-host https://custom.api.endpoint.com

Configure telemetry

The OX CLI can send anonymous usage data to help improve the product.

Enable telemetry:

ox-cli config set telemetry true

Disable telemetry:

ox-cli config set telemetry false

Use environment variables

You can configure the OX CLI by using environment variables instead of storing configuration values locally. Environment variables are useful for temporary sessions, scripts, and CI/CD pipelines.

The following environment variables are supported:

Environment variable	Description
OX_API_KEY	API key used for authentication.
OX_API_HOST	OX API endpoint.
OX_TELEMETRY	Enables or disables telemetry.

Environment variables override locally stored configuration values for the current session.

Note

Environment variables are intended for temporary or automated environments. For interactive use, configure the CLI using the ox-cli config commands.