Atrium
platform docsCLI reference

Atrium platform docs

CLI reference

The current atrium command surface and the platform endpoints each command relies on.

Updated 2026-08-30

Commands

Command Does
atrium login Start device-code auth and store CLI tokens.
atrium logout Revoke or clear stored CLI tokens.
atrium init Check slug availability, scaffold an agent, and register it.
atrium validate Validate local atrium.yaml.
atrium dev Validate, fetch dev bootstrap data, and run local services.
atrium deploy Validate, preview/diff, confirm, and create a deployment request.
atrium status Read resolved state for the current agent.
atrium env Read resolved env for one service.
atrium logs Read Cloud Logging records for one service.
atrium sync Pull control-plane desired YAML into the local checkout.
atrium rename Rename the agent slug with explicit confirmation.

Auth defaults

Production:

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

The API response can include api_base_url. The CLI normalizes that value to the platform API shape before making control-plane calls.

Init

atrium init uses:

GET  /agents/slug/{slug}/availability
POST /agents/register

The scaffolded frontend is installable without extra registry setup.

Use --offline to skip API calls during backend bring-up.

There is not yet a separate atrium register or atrium adopt command for an existing repo with a real manifest. Current deploy previews can still handle an unregistered slug when the request includes the manifest: dry-run returns action: "create" and registration.willCreate=true without writing the agent row. A confirmed deploy persists the manifest and queues the deployment request.

Validate

The validator rejects unknown and platform-owned fields. Current hard errors include:

status
resolved
ui
services.*.cloudRun.service
services.*.cloudRun.region
NEXT_PUBLIC_API_BASE_URL
DATABASE_URL
HASURA_GRAPHQL_DATABASE_URL
NEON_DATABASE_URL

The temporary build-env allowlist contains NEXT_PUBLIC_FEATURE_X.

Dev

atrium dev validates local desired state, fetches development bootstrap data, and starts local service commands.

atrium deploy validates, previews a compact plan, asks for confirmation, and queues a deployment request through the control plane.

Commands that print workflow output default to --format summary. Use --more for full YAML, or pass --format yaml / --format json explicitly for expanded output. atrium env defaults to shell-style KEY=value output and also accepts --format yaml|json|env.

Logs

atrium logs frontend --lines 100
atrium logs frontend --follow

The backend does not stream logs yet. --follow should poll until the API implements streaming.

Current validation status

The CLI crate has passed:

cargo test
cargo clippy --all-targets -- -D warnings
cargo build --release