# Quickstart

> Four steps to a box with your project on it and your coding agent signed in: sign up, install, log in, set up.

URL: https://prized.dev/docs/quickstart

Prefer the terminal? `npx prized` does all four steps in one command ([Sign up from your terminal](https://prized.dev/docs/terminal-signup)).

## 1. Sign up and create a box [#1-sign-up-and-create-a-box]

Sign up at [prized.dev](https://prized.dev/sign-in). New workspaces get [$30 of free credit](https://prized.dev/docs/billing#free-credit), once, and the tour starts a box on it (Nano through Small, no card) in the region nearest you; a Small runs about nine days around the clock. For a bigger size, start its plan on the same step; it launches when the payment lands.

The box bills the credit by the hour while awake, and boxes pause when the credit runs out until you pick a plan ([Billing](https://prized.dev/docs/billing)). Add boxes later with `prized box new` or the [dashboard](https://prized.dev/docs/dashboard#new-box).

## 2. Install the CLI [#2-install-the-cli]

Copy the command the onboarding tour shows you: it installs the CLI, signs it in, and connects your box, so `prized ssh` works when it finishes. The plain installers below only install.

The tour waits here until your machine is signed in, then moves on by itself; there is nothing to click. Installed with a plain command? Run `prized login` (step 3) and it moves on.

macOS and Linux:

```bash
curl -fsSL https://prized.dev/install.sh | sh
```

Windows, in PowerShell or Windows Terminal:

```powershell
irm https://prized.dev/install.ps1 | iex
```

<details>
  <summary>
    Platforms, install folders, options, and verification
  </summary>

  It installs `prized`, its daemon, and a managed Mutagen for sync, and [updates itself](https://prized.dev/docs/cli#updates) from signed releases. It runs on macOS (Apple Silicon and Intel), Linux (x86\_64 and arm64), and Windows 10 1809 or later (x64 and arm64); a few commands are [not on Windows yet](https://prized.dev/docs/cli#windows), and [`prized mount`](https://prized.dev/docs/mount) is macOS-only.

  * **macOS and Linux:** into `/usr/local/bin` when writable, else `~/.local/bin`, added to your shell's startup file; `--no-modify-path` (or `PRIZED_NO_MODIFY_PATH=1`) prints the `export` line instead.
  * **Windows:** into `%LOCALAPPDATA%\Prized\bin`, added to your user `PATH`, no administrator rights; options `PRIZED_VERSION`, `PRIZED_CHANNEL`, `PRIZED_INSTALL_DIR`, and `PRIZED_NO_MODIFY_PATH=1`. In WSL, use the `curl` line.
  * **Verification:** the installer refuses a download it cannot verify: against the release signature when [minisign](https://jedisct1.github.io/minisign/) is installed, otherwise the release's checksum file against a signature-verified digest served with the script. Pinning a release (`--version`, or `PRIZED_VERSION` on Windows) needs minisign.
  * **Telemetry:** the signed-in CLI reports command usage, never arguments or file contents ([turn it off](https://prized.dev/docs/cli#usage-telemetry)).
</details>

## 3. Log in, only if the installer did not [#3-log-in-only-if-the-installer-did-not]

Used the tour's command? Its output shows `✓ signed in as you@…` and `✓ fig connected`: **skip to step 4**.

```bash
prized login
```

Your browser opens the dashboard to make an API key for this machine; paste it back. With exactly one box on your account, login connects it; otherwise `prized setup` does ([what login stores](https://prized.dev/docs/cli#sign-in-and-set-up)).

> The tour's install link works once and for 15 minutes, so running that command again reports it expired. Upgrade with `prized update`, not the install link.

## 4. Set up [#4-set-up]

Run setup on your machine, in the folder you want on the box:

```bash
cd ~/code/myproject   # the folder you want on the box
prized setup
```

It asks once, auto or manual, then repairs what its health check finds, stopping only on what it cannot fix, syncs the folder, brings your environment, and signs your coding agents in on the box. **auto** does all of it without more questions (`prized setup auto` skips the first one too); **manual** asks yes or no per step. Safe to re-run. Setup syncs the folder it runs in, so make it one project, not your home folder or your Desktop.

The tour waits here too, and moves on when setup finishes. It learns that from the CLI's [usage report](https://prized.dev/docs/cli#usage-telemetry); with reporting off, the step offers an **I ran it** link after a short wait. If setup stops with an error, run `prized doctor`, which repairs what it safely can, then run setup again.

<details>
  <summary>
    What each part of setup does
  </summary>

  Setup has four optional parts:

  * **Project:** Syncs the folder you run it in; auto asks first only when it has no `.git` or manifest. `prized setup myproject` creates `~/code/myproject` on the box, mirrored to `~/Prized/myproject`. `prized setup ~/src/myproject` asks whether to sync that folder in place; `--copy-once`, `--copy`, or `--clone` answer up front ([Sync](https://prized.dev/docs/sync#add-a-project)).
  * **Environment:** After a read-only scan, brings your shell, toolchains, CLIs, Docker images, and local databases; installs and secrets default to yes, data to no. Skipped on Windows ([Bring your environment](https://prized.dev/docs/environment)).
  * **Agents:** After one yes, signs the agents found on your machine (Claude Code, Codex, Cursor; `--agent chatgpt` for the ChatGPT app) in on the box over the SSH tunnel; gh and your git identity go along on their own ([Credentials](https://prized.dev/docs/credentials)).
  * **Session:** With one runnable agent picked, starts it in a detached tmux session and prints the reattach command; `--attach` opens it here, `--no-start` skips it.

  If nothing synced, the report's last line says so and gives the command; `prized sync` lists what is synced. No coding agent on your machine? Setup prints how to sign in to Claude Code on the box, or sign in locally and re-run `prized setup` to hand the sign-in over.
</details>

> In Claude Code, select text and press **c**: through `prized ssh` it lands on your clipboard ([Copy out](https://prized.dev/docs/sessions#copy-out)).

Then connect any time, to a persistent tmux session on the box:

```bash
prized ssh
```

`prized status` shows the box's vitals, sync state, mirrored ports, and daemon health; `prized doctor` checks everything when something is off and fixes what it can.

The tour ends on these and the other commands people use most (`prized doctor`, `ssh`, `status`, `exec`, `mount`, `help`), each with a copy button. **Open the dashboard** finishes it; **Help** at the foot of the dashboard's sidebar walks you through it again ([Dashboard](https://prized.dev/docs/dashboard#layout)).

## Or let an agent do it [#or-let-an-agent-do-it]

Steps 2 through 4 are one paste into your coding agent: the prompt is on [Agent setup](https://prized.dev/docs/agent-setup).