Skip to main content
This page is the fastest way to understand the CLI surface without reading each guide separately.

​
Top-Level Commands

CommandUse it for
rmux configureWrite config or inspect resolved config.
rmux aws-checkValidate AWS BYOC setup.
rmux gcp-checkValidate GCP BYOC setup.
rmux newCreate an environment for the current directory.
rmux envList, inspect, and manage environments plus environment-level settings.
rmux workspaceAttach to, inspect, and manage workspaces inside the current environment.
rmux claudeInspect, login, or sync Claude Code auth for RMUX workspaces.
rmux usageShow usage for the current backend.
rmux adminManage API keys and subscription state when your key has admin permissions.
rmux updateInstall the latest published release.
rmux versionPrint the installed RMUX CLI version.

​
Command Groups

​
env

Environment lifecycle and environment-level operations: 
rmux env list
rmux env status
rmux env down
rmux env destroy
rmux env secrets ls
rmux env ports

​
workspace

Workspace-level interaction: 
rmux workspace attach
rmux workspace ls
rmux workspace new server
rmux workspace editor main --vscode
rmux workspace code main
rmux workspace cursor server
rmux workspace run -w server bun run dev
rmux workspace logs server --follow
rmux workspace rm server

​
claude

Claude Code auth sync for local and remote workspaces: 
rmux claude status
rmux claude login
rmux claude sync

​
admin

Admin operations for API keys and subscription state: 
rmux admin keys ls
rmux admin keys create --label "Customer A" --plan starter
rmux admin subscription --key-id <key-id> --status active
These commands are only useful when the current API key has admin permissions.

​
Three Common Flows

​
First setup

rmux configure
rmux aws-check
rmux gcp-check
rmux new
rmux new --seed origin-default
Run the backend-specific check only when that backend supports one.

​
Daily work

rmux workspace attach
rmux workspace run bun test
rmux workspace code main
rmux env status
Use the editor commands only on aws and gcp. e2b and managed still use rmux workspace attach for interactive access. Use git to move later code changes between your local checkout and the remote workspace.

​
Cleanup

rmux env down
rmux env destroy

​
Help Commands

rmux --version
rmux version
rmux --help
rmux help workspace run
rmux env --help
rmux workspace --help
rmux configure --help
rmux --version and rmux version print the installed CLI version. Use the help commands to inspect the current command tree and backend-specific options. When stdout is a TTY, RMUX renders a richer terminal help view for --help, -h, and help subcommands. In scripts and other non-interactive contexts, it falls back to plain help text automatically.

​
Terminal UX

rmux new now shows step-by-step progress while it provisions the remote environment, syncs your workspace, and creates the default workspace. In an interactive terminal, press d to toggle low-level command details during that progress view.

Day-To-Day Workflows

See the common commands in a workflow context.

Configuration

Go deeper on config files, flags, and environment variables.
Last modified on March 24, 2026