Skip to main content
This guide walks you through creating a workspace, installing an app recipe onto it, and validating live routing — all with the rig CLI.

​
Prerequisites

  • A Rigbox account (sign up here)
  • The Rigbox CLI installed: curl -fsSL https://rigbox.dev/install.sh | bash

​
Step 0: Authenticate

The CLI opens your browser to sign in and stores credentials locally, so the rest of these commands need no tokens or headers.

​
Step 1: Create a Workspace

rig workspace spawn creates the workspace, boots it, and waits until it’s ready — all in one call. The dev template is a general-purpose development image with Node.js, Python, and common build tools. Replace my-project with a name of your choice.
The built-in templates are base (minimal) and dev (full toolchain). Everything else — VS Code, Jupyter, Firecrawl, and so on — is installed as an app recipe on top of a workspace, which is the next step.
spawn blocks until the workspace is running. To create without starting, use rig workspace new instead and start it later with rig workspace start --workspace my-project.

​
Step 2: Install an App

App recipes are pre-packaged applications you install into a workspace with a single command. Official recipes are addressed as @rigbox/<id>@builtin. Install the VS Code Server recipe:
The install blocks until the app is live, then prints its name and URL. The app is served at https://<APP_NAME>.rigbox.dev — here, https://my-project-vscode.rigbox.dev.
Preview any official recipe before installing it with rig recipe app info @rigbox/<id>@builtin. See Catalog Apps for the full list of built-in app recipes (Jupyter, Streamlit, Firecrawl, and more).

​
Step 3: List Apps and Validate Live Health

List the apps in your workspace:
Check a specific app is reachable before surfacing its URL in your own UI:
Expected output:

​
Optional: Configure AI Settings

For workspaces with AI integration, set the AI mode:
Provider and model are account-level defaults — set them once with rig ai defaults:

​
Next Steps

Catalog Apps

Install VS Code, Jupyter, Streamlit, and more as app recipes

Workspace API

Full workspace lifecycle management

App Management

Port exposure, visibility controls, and health checks

Snapshots

Save and restore workspace state

AI Configuration

Workspace AI mode, account defaults, and credits

API Keys

Manage programmatic access