Environment Variables
Environment Variables
Environment variables used by the rstream CLI and SDKs.
The rstream CLI can be configured with environment variables. This is useful in stateless environments where a configuration file is not present or should not be written, such as CI jobs and ephemeral containers.
When both a CLI flag and an environment variable are provided for the same setting, the flag takes precedence.
CLI environment variables
| Variable | Meaning |
|---|---|
RSTREAM_CONFIG | Path to the CLI configuration file. |
RSTREAM_API_URL | Hosted API URL used by the CLI when interacting with the control plane. |
RSTREAM_CONTEXT | Name of the context to select. |
RSTREAM_ENGINE | Engine endpoint used for data-plane operations. |
RSTREAM_AUTHENTICATION_TOKEN | Authentication token used by the CLI and SDKs. |
SDK environment defaults
The JavaScript SDK supports environment defaults for engine and credentials through RSTREAM_DEFAULT_ENGINE, RSTREAM_DEFAULT_AUTHENTICATION_TOKEN, RSTREAM_DEFAULT_CLIENT_ID, and RSTREAM_DEFAULT_CLIENT_SECRET.