Skip to main content
Use the rig CLI to deploy projects and manage workspaces from your terminal. The installer also provides rigbox as an alias for the same binary.

​
Prerequisites

  • A Rigbox account.
  • macOS on Apple Silicon or Intel, or Linux on x86-64.
  • A terminal with Bash and curl.
The CLI is already installed inside Rigbox workspaces. For that environment, see Using the CLI.
The default installer follows the stable release. Use the signed CLI 0.13.1 release or later for app-release and tunnel commands, and verify rig --version before using them. Tunnels also require an enabled service; review their exposure and shared-browser-site risks before sharing a local app.

​
1. Install

Run this on your local machine:
The installer verifies the signed release manifest and binary digest before installing rig and rigbox in ~/.local/bin. Confirm the installation:
If your shell reports command not found, add the installation directory to your path:
Add that line to your shell configuration file to keep it for new terminals, then open a new terminal and run rig --version again.

​
2. Sign in

Approve the CLI session in the browser window that opens. Return to your terminal and confirm which account is connected:
The CLI saves its credential in ~/.config/rigbox/config.json, or $XDG_CONFIG_HOME/rigbox/config.json when that variable is set. See Authentication for headless login and API keys. Signing in also sets up SSH access from this machine: the CLI registers your SSH key, creating one if you have none, and adds a Host entry for each workspace, so ssh <workspace> works. See SSH access for what it changes and how to turn it off.

​
3. Choose your next step

Create your first workspace

Create a Linux workspace and install an app.

Deploy your own project

Configure rig.yaml and deploy from your machine.

​
Update the CLI

rig update replaces the rig you ran with the latest published release. It downloads the build for your platform from the public release mirror, verifies the signed release manifest and binary digest, checks that the download runs, and swaps it in for the installed binary, following the rig link to the real file. To install a particular release instead, pass its tag:
To put the new binary somewhere else, set RIG_INSTALL_DIR; the CLI installs it there as rigbox and adds a rig link next to it. If the CLI can’t write to the directory, it stops and says so without touching the installed binary; rerun it with write access or set RIG_INSTALL_DIR. Published builds cover macOS (Apple Silicon and Intel) and Linux x86-64. The CLI checks for a newer release at most once a day. While one is available, commands with human output end with a one-line notice on standard error pointing at rig update. Set RIGBOX_NO_UPDATE_CHECK=1 to turn the check off. You can also rerun the installer. To install a specific published release, set RIG_VERSION on the Bash process that executes the installer:
Set RIG_INSTALL_DIR on the same process to choose another writable installation directory.

​
Inside a workspace

Workspaces come with the CLI installed at /usr/local/bin/rigbox, with rig linked to it. Run rig update there to update it in place, the same as on your machine. Workspaces also keep it current on their own. A couple of minutes after boot, and about once a day after that, a workspace installs the latest release if it has changed. A workspace whose CLI is older than the oldest version Rigbox supports updates to the latest release even when no new one has come out. Either way, the new binary replaces the old one only after it runs, so a failed download leaves the working CLI in place.

​
Build the CLI from source

Building the CLI itself is different from building an app for deployment. The CLI source repository is private; these instructions require repository access and a Rust toolchain:
For normal use, install the published binary above. A Linux ARM binary is not currently published by the installer.

​
Remove the CLI

Add --purge-config only if you also want to remove saved credentials and configuration. This does not delete your hosted workspaces.