Configuration File

Configuration File

Format and semantics of the rstream CLI configuration file.


The rstream CLI stores its local state in a YAML configuration file. The file contains defaults, environments, and named contexts. Commands such as rstream login, rstream project use, and rstream context create update this file.

The configuration schema is intentionally small. Most workflows rely on a default context and a single environment entry.

File structure

At the top level, the configuration contains version, defaults, environments, and contexts. A minimal example looks like this:

version: 1
defaults:
  context:
    name: dev
environments:
  - apiUrl: https://rstream.io
    auth:
      token:
        storage:
          kind: inline
          value: "<token>"
contexts:
  - name: dev
    apiUrl: https://rstream.io
    projectEndpoint: "<project-endpoint>"
    engine: "<engine>"
    auth:
      token:
        storage:
          kind: inline
          value: "<token>"
    transport:
      mptcp: false

The example shows inline token storage, which is supported by the current CLI implementation. A keychain storage mode exists in the schema but is not supported yet.