Back to home

Quick Start

Get Atlas running locally in under 5 minutes. All you need is Docker, Node.js 20+, and pnpm.

Prerequisites

  • Docker Desktop (running)
  • Node.js ≥ 20.0.0
  • pnpm ≥ 9.0.0

1. Install the Atlas CLI

Install the Atlas command-line tool globally.

bash
npm i -g @atlas/cli

2. Install dependencies

Atlas uses pnpm workspaces for package management.

bash
pnpm install

3. Initialize infrastructure

This pulls Docker images and starts Caddy, Logto, and PostgreSQL.

bash
pnpm -w exec tsx apps/cli/src/index.ts init

4. Start the Manager API

The Manager API handles project lifecycle. Run it in a separate terminal.

bash
pnpm dev:manager

5. Create your first project

Spin up an isolated backend with a single command.

bash
atlas create my-first-app

6. Open the Dashboard

Manage your project's collections, records, and settings from the Atlas dashboard.

bash
atlas open my-first-app

7. Start the Dashboard (optional)

Launch the Atlas web dashboard for visual project management.

bash
pnpm dev:dashboard

What's next?

  • Connect your app: Use your project's REST API to connect your frontend. API keys are available in Dashboard → Settings.
  • Define your schema: Use the Collections tab in the Atlas dashboard to create collections, define fields, and manage records.
  • Generate API keys: Go to Dashboard → Settings → API Keys to generate atk_ prefixed keys for programmatic access.