Skip to main content
The rig and rigbox commands run the same CLI. This reference is generated from CLI revision 824aefd, which reports its version as 0.13.0-rc.5. Start with installation and authentication. For a working application, follow the quickstart.

Find a command

Choose a command below, then follow its subcommand links. Each page includes its execution mode, example invocations, arguments, flags, and complete help. Configuration and output explains scripting options. Local versus workspace CLI explains which command surface to use.

Local tunnels

rig tunnel requires the signed stable CLI 0.13.1 or later and an enabled tunnel service. It gives a fixed loopback service an HTTPS URL under rigbox.link. Start privately and review the whole-app exposure and shared-browser-site limitation before sharing. Rigbox protects its own access cookies; another tunnel can still set parent-domain cookies that interfere with your app’s cookies. The generated command reference above retains its existing source version.

Source and coverage

The command tree comes from the CLI’s Clap definitions at v0.13.0-rc.5 (revision 824aefd), including both local and workspace modes. Inside a workspace, some commands parse but refuse with a one-line message saying where they work; their pages say so. Hidden internal commands and Clap’s automatically generated help routing aliases are excluded; every documented command supports --help. Syntax and flags are generated independently of maintained examples. Examples containing uppercase placeholders require your values. Commands that create, change, or delete resources perform those operations when run; --help is always offline.

Install

This material now lives in the dedicated guide or command reference.

Inside a workspace

This material now lives in the dedicated guide or command reference.

On your local machine

This material now lives in the dedicated guide or command reference.

Pin a version or change the install directory

This material now lives in the dedicated guide or command reference.

Shell completions

This material now lives in the dedicated guide or command reference.

Authentication

This material now lives in the dedicated guide or command reference.

Log in (local machine)

This material now lives in the dedicated guide or command reference.

API keys

This material now lives in the dedicated guide or command reference.

Runtime modes

This material now lives in the dedicated guide or command reference.

Global flags

This material now lives in the dedicated guide or command reference.

HTTP traces and body capture

This material now lives in the dedicated guide or command reference.

Persisted defaults

This material now lives in the dedicated guide or command reference.

Raw API access

This material now lives in the dedicated guide or command reference.

Deploy

This material now lives in the dedicated guide or command reference.

Loading .env files

This material now lives in the dedicated guide or command reference.

Blue-green and promote

This material now lives in the dedicated guide or command reference.

Scaffold a manifest

This material now lives in the dedicated guide or command reference.

The rig.yaml manifest

This material now lives in the dedicated guide or command reference.

Single-app form

This material now lives in the dedicated guide or command reference.

Field reference

This material now lives in the dedicated guide or command reference.

Multi-app form

This material now lives in the dedicated guide or command reference.

Command reference

This material now lives in the dedicated guide or command reference.

Account

This material now lives in the dedicated guide or command reference.

workspace

This material now lives in the dedicated guide or command reference.

app

This material now lives in the dedicated guide or command reference.

snapshot

This material now lives in the dedicated guide or command reference.

volume

This material now lives in the dedicated guide or command reference.

build, release, rollback

This material now lives in the dedicated guide or command reference.

ssh

This material now lives in the dedicated guide or command reference.

tools

This material now lives in the dedicated guide or command reference.

template

This material now lives in the dedicated guide or command reference.

recipe

This material now lives in the dedicated guide or command reference.

publish

This material now lives in the dedicated guide or command reference.

setup-script & service-spec

This material now lives in the dedicated guide or command reference.

proxy (workspace-only)

This material now lives in the dedicated guide or command reference.

API reference

This material now lives in the dedicated guide or command reference.