Quickstart

Install and sign in

Install from the stable release channel, then check your installed version:

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

The command examples in these guides were checked against published CLI 0.1.16. Its published release currently provides Linux x64; check the release manifest before assuming another operating system has a prebuilt binary. A locally built binary with the same version can contain unreleased changes.

Open the activation URL printed by login, sign in, and approve the intended workspace. Keep CLI credentials private. See CLI authentication for programmatic clients.

Choose a starter

atrium init my-agent --profile nextjs

Choose one profile when creating your app:

Profile	Generated services	Local prerequisites
nextjs	frontend	Node.js compatible with the generated Next.js package and Bun.
nextjs-fastapi	frontend, backend	Frontend tools plus Python, pip, FastAPI, and Uvicorn.
nextjs-fastapi-hasura	frontend, backend, database	The above plus Hasura/PostgreSQL and migrations.

The CLI supplies embedded templates, example environment files, and health routes: frontend /api/health, backend /health, and Hasura /healthz. The Hasura profile does not automatically start a local Hasura container or provision a production database.

Online initialization checks the slug and registers the app. Clients can inspect the read-only init-plan API before local writes; the CLI has no separate init --plan flag. To generate files without registration:

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

Run only the profile command you need. Offline generation does not create a workspace app or resources. Avoid --force on an existing project: it permits overwriting colliding starter files.

Prepare dependencies

From the newly created app directory, install frontend dependencies:

cd my-agent
bun install --cwd frontend

For a profile with a backend, create and activate a Python environment and install its dependencies:

python3 -m venv .venv
. .venv/bin/activate
python -m pip install -r backend/requirements.txt

Follow the generated service files for framework requirements. Keep local environment files out of git. For the Hasura profile, confirm database prerequisites first; managed isolated dev databases currently require additional platform setup.

Validate and run locally

atrium validate
atrium dev

The CLI validates the manifest, requests a workspace development session, and starts supported local services with development configuration. See Local development for session reuse, stopping, expiry, and unavailable database handling.

Your manifest must not contain credentials or resolved platform values. Local validation does not replace the server's access/billing validation. Consult the manifest reference.

Deploy and verify

atrium deploy
atrium status
atrium deployments --limit 5

Review the deployment preview and source before confirming. Eligible uncommitted files are uploaded. Follow the build to its terminal result, then open the returned app URL and check the declared health routes with the appropriate access. A queued request or resolved URL is not a successful deployment.

Before customer use, configure access and an explicit Free or paid plan if routes require a subscription. Test enrollment from a customer workspace as well as developer access from the owning workspace.