CLI Reference

Reference documentation for the rstream CLI.

Written by uartnet

@uartnet

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 provides reference pages for the command surface and the configuration mechanisms used by the CLI. For a conceptual overview of projects and contexts, see CLI Workflow.

The CLI always exposes help output:

rstream --help

Command-specific help is available as well:

rstream forward --help

Create a Tunnel Commands