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. Incremental app-release commands require v0.13, currently available as a release candidate. Follow the release’s installation instructions and verify rig --version before using those commands.

​
1. Install

Run this on your local machine:
The installer places 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.

​
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

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.

​
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.