Atrium
platform docsCLI reference

Atrium platform docs

CLI reference

Commands and flags verified against the published Atrium CLI, with links to task-oriented guides.

Updated 2026-09-22

Release and global options

These commands were checked against the published stable CLI 0.1.16, not a locally patched binary. Check atrium --version and atrium <command> --help when following an example.

Global options:

  • --manifest <PATH>: manifest path, default atrium.yaml.
  • -y, --yes, --assume-yes: skip confirmation prompts. Use only with reviewed inputs.
  • -h / --help, -V / --version.

Authentication

atrium login
atrium logout

Login uses browser device-code approval in your intended workspace. See Authentication. CLI 0.1.16 has no workspace subcommand; programmatic workspace selection is documented in the API reference.

Initialize and validate

atrium init my-agent --profile nextjs-fastapi
atrium validate

init accepts --slug, --description, --owner, --directory, --offline, and --force. Profiles are nextjs (default), nextjs-fastapi, and nextjs-fastapi-hasura. --offline skips registration. --force permits overwriting colliding files.

Quickstart covers generated files and dependencies. Server-side manifest validation remains authoritative for features passed through by the local validator.

Development sessions

atrium dev --service frontend --service backend
atrium dev --ttl-seconds 3600
atrium dev status
atrium dev stop
atrium dev --fresh

Use the applicable command, not all commands in sequence. Service flags are repeatable. The TTL defaults to 28,800 seconds. Status does not start services or a heartbeat; stop revokes the session. See Local development for reuse, environments, and database availability. Reverse tunnels and local unpublished startup patches are not part of this release reference.

Deploy and inspect

atrium deploy
atrium deploy --no-follow
atrium deploy --follow-timeout 1200
atrium status --format json
atrium deployments --limit 10
atrium deployments --before "2026-09-20T12:00:00Z" --limit 10

The deploy invocations are alternatives. Following defaults to 600 seconds; 0 waits for a terminal event. The history page size defaults to 10. Use the returned next-page timestamp for --before. See Deployments for source uploads, stages, and stopping a follower.

Output formats

init, deploy, status, deployments, and rename support --format summary|yaml|json|env. Their default is summary. --more expands summary output to YAML; an explicit format takes precedence. Not every command accepts these options: consult its help before scripting it.

atrium env backend --format env
atrium env backend --format json

env defaults to env output and accepts the same formats. Treat its output as potentially secret; do not include it in public issue reports or commit it.

Logs

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

-f aliases --follow; --lines defaults to 100 and maps to the API's limit. Following streams deployment events, while recent reads can include runtime logs. It is not a continuous runtime-log tail. The API reference adds cursor, deployment selection, SSE, and NDJSON options for custom clients.

Synchronize and rename

atrium sync
atrium rename new-slug

Review sync before replacing local desired state. Rename requires confirmation and can affect URLs and integrations. Neither command is a source-code editor or automatic git-commit workflow. See Manifest lifecycle.