Skip to main content
Run these commands on your local machine after installing and signing in. Use the command reference for the complete list of commands and flags.

​
Find a command

Help is available at each level:
If a guide uses a command missing from your installation, run rig --version and update the CLI. GitHub Actions bindings require CLI v0.12.64 or newer.

​
Select a workspace

List your workspaces and use a name or ID from the result:
Replace my-project with your workspace. Creation commands use --name to name a new workspace; management commands generally use --workspace to select an existing one. Check the command’s --help for its accepted flags.

​
Inspect an app

Copy the actual app name from the result, then inspect its health:
A running process does not necessarily mean an app is reachable. Check the reported live status and listening port before opening the app URL.

​
Deploy a project

From a directory containing rig.yaml:
The CLI uses an explicitly selected workspace, reuses a workspace recorded in .rig.lock, or creates one when no target is bound. Inside a workspace, it deploys into that workspace. Follow Deploy from your machine to create and review the manifest first.

​
Use structured output

Human-readable output is the default. Request JSON when piping results to another program:
Use --query to select values from structured output, and consult global flags for input files and persistent output settings.

​
Inside a workspace

Every workspace has the CLI preinstalled, signed in as the workspace itself. You do not need to run rig login. The same commands work there as on your machine, acting on the current workspace, so an agent or script in the workspace can deploy, read logs, and query the API:
A few commands stay on your machine: signing in and out, API keys and SSH keys, GitHub bindings, image releases and rollbacks, uninstalling, workspace lifecycle, and changes to account setup scripts and service specs. Inside a workspace they refuse with one line that says where they work. Update the workspace’s CLI with rig update. See Local versus workspace CLI for the full list and how rig deploy behaves there.