> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Launch your first workspace and install your first app with production-safe CLI steps

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](https://rigbox.dev/signup))
* 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.

```bash theme={null}
rig login
```

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

```bash theme={null}
rig workspace spawn --name my-project --template dev
```

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.

<Tip>
  `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`.
</Tip>

## 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:

```bash theme={null}
rig recipe app install -r @rigbox/vscode@builtin -w my-project
```

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

<Tip>
  Preview any official recipe before installing it with `rig recipe app info @rigbox/<id>@builtin`. See [Catalog Apps](/guides/catalog) for the full list of built-in app recipes (Jupyter, Streamlit, Firecrawl, and more).
</Tip>

## Step 3: List Apps and Validate Live Health

List the apps in your workspace:

```bash theme={null}
rig app ls --workspace my-project
```

Check a specific app is reachable before surfacing its URL in your own UI:

```bash theme={null}
rig app health --app <APP_NAME>
```

Expected output:

```json theme={null}
{
  "live": true,
  "service_status": "running",
  "port_open": true
}
```

## Optional: Configure AI Settings

For workspaces with AI integration, set the AI mode:

```bash theme={null}
rig workspace ai mode --workspace my-project managed
```

Provider and model are account-level defaults — set them once with `rig ai defaults`:

```bash theme={null}
rig ai defaults --provider google --model google/gemini-2.5-pro
```

## Next Steps

<CardGroup cols={2}>
  <Card title="Catalog Apps" icon="grid" href="/guides/catalog">
    Install VS Code, Jupyter, Streamlit, and more as app recipes
  </Card>

  <Card title="Workspace API" icon="server" href="/api-reference/workspaces/list">
    Full workspace lifecycle management
  </Card>

  <Card title="App Management" icon="globe" href="/api-reference/apps/list">
    Port exposure, visibility controls, and health checks
  </Card>

  <Card title="Snapshots" icon="camera" href="/api-reference/snapshots/list">
    Save and restore workspace state
  </Card>

  <Card title="AI Configuration" icon="sparkles" href="/api-reference/ai/get-workspace-ai-config">
    Workspace AI mode, account defaults, and credits
  </Card>

  <Card title="API Keys" icon="key" href="/api-reference/api-keys/list">
    Manage programmatic access
  </Card>
</CardGroup>