CLI Reference

The rstream CLI is a single binary named rstream. Most operational workflows use a small set of commands (login, project use, forward, run, events), but the CLI also exposes configuration and inspection commands that are useful in automation and troubleshooting.

This section is the reference layer for the CLI. The command surface is documented in Commands, persistent state in Configuration File, and stateless runtime configuration in Environment Variables. For the conceptual model behind projects, contexts, hosted APIs, and engine endpoints, see CLI Workflow.

By default, the CLI stores local configuration under ~/.rstream/config.yaml. The path can be changed with RSTREAM_CONFIG, which is useful for CI jobs, temporary environments, and tests that must not read or mutate the user's normal CLI state.

The CLI always exposes help output:

rstream --help

Command-specific help is available as well:

rstream forward --help