Commands
Commands
Top-level commands and common workflows.
The CLI groups commands into a small number of operational areas: authentication, project and context management, tunnel operations, declarative management, and signaling.
The root command is rstream. It accepts global flags that affect configuration loading and logging.
Top-level command surface
The CLI registers the following top-level commands:
| Command | Summary |
|---|---|
login | Authenticate the CLI and store a token locally. |
logout | Remove the stored token from the local configuration. |
project | List projects and create a context from a project endpoint. |
context | Create, update, select, and inspect local contexts. |
forward | Create a tunnel and forward traffic to a local target. |
tunnel | List tunnels visible through the current engine and token. |
run | Manage tunnels declaratively from YAML or Docker labels. |
events | Subscribe to the event stream over SSE or WebSocket. |
webtty | Run or connect to a WebTTY server. |
The exact subcommands and flags evolve over time. Use the built-in help output to inspect the installed version.
Help and versioning
To inspect a command, use the --help flag:
rstream tunnel --help