Getting started

Three steps. Each links to the full page when you want the details.

1. Install#

curl -fsSL https://atlas.codeatlas.com.br/install.sh | bash
atlas version

Public release soon. The installer and the release assets go live when the repository becomes public. Until then, build from source.

The installer verifies the release checksum and puts atlas in ~/.atlas/bin. If that directory is not on your PATH, it prints the line to add; atlas install does it for you. Manual install, updates, building from source and uninstalling: Installation.

2. Describe your stack#

In your project root:

atlas init                              # scaffold atlas.yaml
atlas config schema > .atlas.schema.json   # editor autocompletion

# yaml-language-server: $schema=.atlas.schema.json
name: myapp

services:
  database:
    port: 5432            # no command: externally managed (docker), port-watched

  api:
    command: bun run dev:api
    port: 3000
    health: http://localhost:3000/health
    depends_on: [database]
    open_key: a

  web:
    command: bun run dev:web
    port: 3001
    depends_on: [api]

infra:
  compose_file: docker-compose.yml

atlas config check validates it and prints every error at once. Every field is documented in Configuration.

3. Run it#

atlas dev

A tab per service, merged logs on All, service states in the sidebar. ? shows the keys, / searches the logs, q quits and stops everything. See the TUI guide.

To leave the stack running in the background: atlas dev --detach, then atlas dev to attach and atlas down to stop.

What next#

I want to…	Read
walk through the whole flow with more detail	Quickstart
understand the vocabulary	Concepts
use the native app	Desktop app
let an AI agent read logs and restart services	Agent setup, MCP
find a flag or exit code	CLI reference
fix something that broke	Troubleshooting