Environment Variables
Environment variables used by the rstream CLI and SDKs.
The rstream CLI and SDK helpers 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 CLI setting, the flag takes precedence. For runtime resolution, explicit flags are read first, then environment variables, then the selected context and default context stored in the configuration file.
Shared runtime 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. |
Go SDK transport helper
| Variable | Meaning |
|---|---|
RSTREAM_QUIC_TRANSPORT | When set to 1, Go SDK config helpers use QUIC as the client-to-edge tunnel transport. Persisted transport configuration uses transport.useQuic. |
RSTREAM_QUIC_TRANSPORT changes only the client-to-edge session. It does not create a published QUIC tunnel; published tunnel protocol is still selected through tunnel properties such as protocol: quic or CLI protocol flags.
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.