Prized docs

Dashboard.

Every screen in the signed-in app at prized.dev/dashboard, what each control does, and where a setting lives. The feature pages explain the behaviour; this one says where to click.

Layout

The dashboard is one sidebar and one page at a time. A new sign-up meets it after the onboarding tour (Quickstart).

PartWhat it does
SidebarThree groups, top to bottom: Boxes, Snapshots, Environments; Filesystem, Connectors, Secrets; Workspace, Billing, Settings. The button at the left of the top bar (or Cmd/Ctrl+B) collapses it to an icon strip.
Top barThe breadcrumb, and New box at the right of every page (gone while the workspace is closing).
Account rowThe workspace name and your email at the bottom of the sidebar. Click it for Switch workspace (only when you belong to more than one), Workspace, Billing, Settings, and Sign out.
Free credit noteOn the free credit, the sidebar footer counts down what is left, with an Upgrade button. It goes once you have a plan.
BannerA line across the top of every page when money needs attention: credit running low, free credit used up, balance empty and boxes suspended, in overage, a failed plan payment, or no plan chosen yet (that one links to the plan step). The others link to Billing. A closing workspace shows the deletion date and Reopen instead. See When we tell you.

Screens

ScreenRouteWhat you can doDetails
Boxes/dashboardSee every box, its state and vitals; copy its prized ssh commandBoxes
New box/dashboard/boxes/newPick a size, name, template, environment and per-box vars; createCreate
Box: Overview/dashboard/boxes/<id>Pause, resume, resize, move region, snapshot, fork, template, auto-pause, deadline, env vars, phone access, delete; the event logBoxes
Box: Terminal/dashboard/boxes/<id>/terminalA shell in the box's tmux sessionSessions
Box: Desktop/dashboard/boxes/<id>/desktopA Linux desktop or one Chrome window, streamedDesktop
Box: Monitor/dashboard/boxes/<id>/monitorLive and historical cpu, memory, network, disk, ports and processesTelemetry retention
Box: Files/dashboard/boxes/<id>/filesBrowse, edit, upload, download, rename and delete filesFiles below
Box: Secrets/dashboard/boxes/<id>/secretsMount and unmount workspace secrets on this boxSecrets tab below
Snapshots/dashboard/snapshotsTake, restore, delete, name templates; undo a box deleteSnapshots
Environments/dashboard/environmentsCreate and edit what new boxes inherit; upgrade boxesEnvironments
Filesystem/dashboard/filesystemPick a running box to browseFiles below
Connectors/dashboard/connectorsMount a provider credential into a boxConnectors
Secrets/dashboard/secretsCreate, rotate and delete brokered secretsSecrets for agents
Workspace/dashboard/workspaceName, icon, domain, invite link, members, CLI tokens, data and privacy, close, eraseWorkspaces
Billing/dashboard/billingPlan, balance, top-ups, overage, what each box burns, activity, the Stripe portalBilling
Settings/dashboard/settingsYour name, sign-in providers, browser sessionsSettings below

Boxes

/dashboard is a grid of cards, oldest first. Each card shows the name, state, size, last heartbeat, cpu, memory and disk, and the box's prized ssh <name> command (click it to copy). Click the card to open the box; deleted boxes leave the grid.

New box

New box in the top bar opens /dashboard/boxes/new.

ControlWhat it does
Size ladderOne cell per size; arrow keys move between them. A size your balance cannot keep running is blocked with a line that says why, unless the plan offer below is checked; see Starting and resizing boxes.
NameA fruit name is suggested; type your own or leave it. There is no rename later: a box keeps the name it was created with.
Start fromOnly once you have a template: the box boots that disk, and the ladder jumps to the template's size. The new box from this link on Snapshots lands here with the template preset.
EnvironmentOnly once you have an environment: your default is preselected; none gives the box no repos, script, vars or files.
Env vars for this boxNAME=value, one per line, editable later on the box page; see Per-box vars.
Restricted (safe for third parties)Closes every credential channel to the box, permanently; see Safe for third parties.
Plan offerWorkspace owners see a checked offer when the box would outgrow the plan: Switch to the $X/mo plan; uncheck it to create on the current plan. With no plan and an empty balance it offers Start on the $X/mo plan instead, and the button reads Continue to checkout.
Create boxBack to the grid, where the new card shows up provisioning. A taken name, the box limit, or too little balance is refused with the reason.

A closing workspace shows no ladder; reopen it from Workspace first.

The box page

Every box has six tabs: Overview, Terminal, Desktop, Monitor, Files, Secrets. The header above them shows the name, the state, the last heartbeat and the prized ssh chip.

Overview

Vitals (cpu, memory, disk; uptime and pauses survived) and Machine (size, disk, region, created) lead. Then Actions, one row per setting:

RowWhat it doesDetails
Pause / ResumeOne button whose verb follows the state.Pause and resume
EnvironmentThe pinned environment and version (restricted when the box is), Upgrade to vN when a newer version exists, and Vars to edit the per-box vars (Save vars replaces the set).Versions and upgrade
Auto-pauseOff, or after 30 minutes, 1, 2, 4, 8 or 24 hours idle; while set, the row shows how long the box has been idle so far.Auto-pause
Pause atNo deadline, in 1, 4, 12 or 24 hours, or Custom window (hours, or 90m, 36h, 3d), then Set. Picking a new window extends a deadline; the row is hidden while the box is paused.Pause deadline
ResizePick a size card, then confirm: Resize, or Resize and switch for $X today with Just resize under it when the new size outgrows the plan.Resize
Move regionShown only when there is more than one region. Picking one starts the move; the button stays off while a move is in flight.Regions
SnapshotA name and an optional description, then Create snapshot.Take a snapshot
Save as templateA template name, then Save.Templates
Automatic snapshotsOff, or an interval from every hour to every week, and how many to keep.Automatic snapshots
ForkAn optional name, a size whose disk holds the copy, keep the disk copy as a snapshot afterwards, then Fork, which opens the new box's page.Fork a box
Phone accessSet up shows host, port and username. Generate password shows the password once, Regenerate password replaces it everywhere, Revoke removes it.From your phone
Delete boxA dialog that asks you to type delete <name>. The undo is Recently deleted on Snapshots.Deleting a box

A refusal shows under the rows in the server's own words. Events closes the page: the last 50 state changes, each with its reason, actor and time.

Terminal

A shell in the box's persistent tmux session main, the same one prized ssh opens: a CLI window and this tab show the same screen, and closing the tab loses nothing. Opening it wakes a paused box. See Sessions.

  • The header lists the session's tmux windows as chips; click one to switch. Full screen sits at the right, and reconnect appears after a drop.
  • Select to copy: Cmd+C on a Mac, Ctrl+Insert or the right-click menu elsewhere; Ctrl+C goes to the shell. Nothing on the box can read or write your clipboard through this tab.

Desktop

Pick Desktop or Browser, then Open desktop or Open browser; the rest is on Desktop.

Monitor

The range switcher sits in the tab row: live, 1h, 6h, 24h, 7d, 30d. Live streams every 2 seconds, seeded with the last hour; the other ranges are stored history with averages and a max band, paused spans shaded, and lifecycle events as ticks. The panels are cpu (per core when live), memory, network, disk, ports · tmux, and processes (sorted by cpu or mem).

  • Hover a chart for the value at that time. Click to pin the moment, and the ports and processes panels swap to the nearest stored snapshot; Esc, unpin or back to live releases it.
  • The monitor never wakes a paused box. How long history is kept is on Data retention.

Files

A file browser over the box's own SSH, as the box's login user. It needs a running box and never wakes a paused one; the Filesystem page in the sidebar lists the running boxes with a Browse files button each.

  • Each row has download (files only), rename and delete; delete confirms inline.
  • Click a file to open it. A text file within the inline cap opens in an editor (Save writes the whole file back, Esc closes without saving); a bigger text file shows its head read-only, and a binary file offers download instead.
  • Transfers run one at a time; the size caps are on Limits.

Secrets tab

Which workspace secrets this box receives as env vars: each mount with Unmount beside it, then a secret picker, an env name and Mount. Mounts need a running box, and a restricted box refuses them. The secrets themselves live under Secrets.

Snapshots

New snapshot picks a box, a name and an optional description. Everything you have taken is one table, newest first, with each snapshot's kind, box, size, status and age.

  • Restore: an optional name for the new box, then Restore. Only an available snapshot restores.
  • Make template (or Rename on a template): name the snapshot so new boxes can start from it.
  • Delete: click once, then Confirm delete. A snapshot still creating shows Cancel instead.
  • templates, above the table once you have one: new box from this opens New box with the template preset, and Drop name keeps the snapshot as a plain one.
  • recently deleted, below the table: the undo copies of deleted boxes, with their days left. Restore is prefilled with the box's old name; Delete now removes a copy early.

Kinds, limits and the CLI are on Snapshots.

Environments

One card per environment with Make default, Edit, and Delete (a dialog that asks you to type delete <name>). New environment asks for a name, description, base size (the size New box preselects for it), env vars, a setup script, and Make it the default for new boxes; repos, secret files and the credential switches are added on the card afterwards. Edit opens the card as sections, each saving on its own:

SectionControls
GeneralName, description, base size, setup script; Save. Only a changed script mints a version.
Credentials a box may receiveSafe for third parties, or the channels one at a time: Secret mounts, Device keys, Phone access
Env varsThe list with Remove per var; NAME, value and Set to add or replace one
Secret filesA path relative to the box home, contents pasted or picked from a file, Set file; existing files show path, mode and size only
Reposowner/name or an https URL, branch, directory, an optional script run inside the clone, blocking; Add repo
VersionsEvery version with its box count; Upgrade N boxes to vX pins them all to the latest (one box at a time from that box's page)

What a box receives from each field, and the limits, are on Environments.

Connectors

One card per provider; Connect opens the provider's page, which asks for a running box, the credential, the env name (the provider's conventional one is prefilled) and, for ClickHouse, the HTTPS endpoint. Done, it offers Box secrets to see the mount. See Connectors.

Secrets

Add secret asks for a name, the value, the allowed hosts, and a description. The table lists each secret's name, placeholder, hosts, mount count and last rotation.

  • Rotate takes a new value and/or new hosts; the placeholder stays, so mounted boxes keep working.
  • Delete is two clicks: Delete, then Confirm delete.
  • Values are write-only: nothing here shows one after it is saved.

How the broker swaps the value in is on Secrets for agents.

Workspace

Everything on this page belongs to the whole team; owner-only controls say so to members. While the workspace is closing every control is read-only and the banner's Reopen is the way back.

SectionControlsDetails
IconUpload image, Remove, and Use domain favicon once a domain is claimedWorkspace limits
NameThe workspace name and Save (owner)Create one
DomainClaim @yourdomain, then the auto-join and restrict-membership switchesCreate one
Invite linkThe link, Copy, and New link (owner)Invite people
MembersEach member with their role; Remove (owner) or Leave (a member, on their own row)Remove someone
CLI tokensEvery machine signed in with prized login, with when it was last used, the CLI version it reported and whether it registered an SSH key. Revoke per machine; Revoke all after a confirmation.CLI tokens, Credentials Prized issues
Data and privacyZero data retention: Turn on (a typed confirmation) or Turn offZero data retention
Close workspaceClose workspace, confirmed by typing the workspace's name; while closing, the section names the deletion date insteadClosing a workspace
Erase nowErase workspace now (owner), confirmed by typing the workspace's nameClosing a workspace

Billing

Everyone in the workspace can read this page; only the owner sees the controls.

SectionWhat it shows or does
Payment failedOnly while a plan payment is failing: the date and what to do
PlanThe current plan and its renewal date, a nudge when your boxes fit a smaller plan or outgrow this one, and the plan cards: Choose (no plan yet), Upgrade now or Switch next cycle (a second click confirms), Cancel plan, and Resume this plan while a cancel is scheduled. See Choosing and changing the plan.
BalanceThe balance, with running low, out of credit or in overage beside it, and how long it lasts at the current burn. Add credit once buys a top-up in Checkout; the Overage checkbox is overage.
What you're burningEvery live box, awake or asleep, and its hourly rate right now
Recent activityThe last 50 ledger lines
Payment & invoicesManage in Stripe opens the Stripe portal for the card, invoices and receipts

Settings

Your account, not the workspace: what you sign in as, and where you are signed in.

SectionControls
ProfileYour name and Save. The email and photo come from your sign-in provider.
Sign-in methodsGoogle and GitHub (where enabled): Connect links another provider to this account by its verified email, Disconnect unlinks one. Your only sign-in method cannot be disconnected.
SessionsEvery browser this account is signed in from; Sign out per session, or Sign out other sessions.

CLI tokens are per workspace, not per account, so they live under Workspace; the sign-in model is on Identity and access.

Where a setting lives

SettingWhere
Box nameNew box, at create; no rename later
Auto-pause, pause deadlineBox page, Overview, Auto-pause and Pause at
Size, regionBox page, Overview, Resize and Move region
Per-box env vars, environment versionBox page, Overview, Environment
Snapshot scheduleBox page, Overview, Automatic snapshots
Phone SSH passwordBox page, Overview, Phone access
Secrets mounted on a boxBox page, Secrets tab
Default environment, safe for third partiesEnvironments
Workspace name, icon, domain, invite link, membersWorkspace
CLI tokens and device SSH keysWorkspace, CLI tokens
Zero data retention, close, eraseWorkspace, Data and privacy, Close workspace, Erase now
Plan, top-ups, overage, card, invoicesBilling (owner)
Sign-in providers, browser sessionsSettings
CLI usage telemetryNot in the dashboard: CLI: usage telemetry
Dashboard analyticsYour browser's Do Not Track setting: Privacy

Something unclear or out of date?

On this page