Atrium
platform docsQuickstart

Atrium platform docs

Quickstart

Install the Atrium CLI, log in, create an agent manifest, validate it, and deploy through the control plane.

Updated 2026-08-30

Install the CLI

Install the stable CLI:

curl -fsSL https://storage.googleapis.com/atrium-releases/install.sh | sh

The installer places the atrium binary on your local path and follows the stable release channel.

Platform contributors can still build the CLI from source:

cd /mnt/disks/data-disk/code/atrium/cli
cargo build --release

The CLI stores credentials in the OS keyring under service name atrium. When keyring storage is unavailable, it falls back to a private local tokens.json file.

Log in

atrium login

The CLI starts an OAuth device-code flow and prints an activation URL on the auth app. The browser approval page is the source of truth for Supabase login and workspace context.

Production endpoints:

device code: https://api.atrium.st/v0/oauth/device/code
token:       https://api.atrium.st/v0/oauth/token
api:         https://api.atrium.st/v0

Sandbox endpoints used during bring-up:

auth: https://auth.peter.sandbox.atrium.st
api:  https://api.peter.sandbox.atrium.st/v0
app:  https://app.peter.sandbox.atrium.st

Create an agent

atrium init my-agent

init checks slug availability, registers the agent, and scaffolds a starter frontend that is installable from public packages.

For backend bring-up or offline docs work, use:

atrium init my-agent --offline

Offline mode writes files without calling the control plane.

Validate the manifest

atrium validate

Validation is strict. Platform-owned fields such as status, resolved, ui, cloudRun.service, cloudRun.region, NEXT_PUBLIC_API_BASE_URL, DATABASE_URL, and HASURA_GRAPHQL_DATABASE_URL are hard errors.

Run locally

atrium dev

dev validates the manifest, asks the control plane for development bootstrap data, and starts the local service commands with resolved development environment.

Deploy

atrium deploy

Deploy validates local desired state, previews a compact plan, asks for confirmation, and creates a control-plane deployment request. The CLI does not write cloud infrastructure directly.