Documentation

Build with Atlas

Everything you need to install, configure, and get the most out of the terminal-native AI coding agent.

Install in one line
curl -fsSL https://runatlas.sh/install | sh
Introduction

Atlas is an open, terminal-native AI coding agent. It lives in your shell, reads your repository, and works the way you already do: keyboard-first, diff-driven, and under your control at every step.

Three principles shape how Atlas behaves:

  • Plans before edits. Atlas proposes a plan and a diff, then waits for your approval before touching the tree.
  • Permission-gated. Every tool call runs behind a permission mode you choose. Nothing leaves your machine without your say-so.
  • Extensible by design. Plugins, themes, and Model Context Protocol servers let you shape Atlas around your stack.
Installation

Atlas ships as a single binary with no runtime to babysit. Pick the method that fits your platform.

macOS & Linux

bash
curl -fsSL https://runatlas.sh/install | sh

Homebrew

bash
brew install syntora/tap/atlas

Windows (PowerShell)

powershell
irm https://runatlas.sh/install.ps1 | iex
Verify the install
Run atlas --version to confirm Atlas is on your PATH.
Quickstart

Open Atlas inside any repository and hand it a task. It reads your stack and conventions, drafts a plan, and shows the diff before anything changes.

terminal
cd ~/code/your-project
atlas

› Add a health check endpoint to the API

Atlas responds with a plan. Review it, refine it, or approve it. Approved changes land as a diff you can inspect and commit like any other.

Note
Prefer to start from a single instruction? Launch with atlas --prompt "fix the failing tests" and Atlas submits it on open.
Configuration

Atlas reads an optional config file from ~/.atlas/config.json. Project-level overrides live in atlas.json at your repository root.

~/.atlas/config.json
{
  "model": "claude-opus-4-8",
  "theme": "atlas",
  "permission": "ask",
  "animations_enabled": true
}

permission accepts ask (confirm every tool call), auto (run read-only tools freely), or plan (read-only, no edits).

Themes

Atlas ships with the charcoal-black + blue atlas theme and a stack of community themes. Switch live with the /theme command, or set a default in your config.

custom theme
{
  "name": "midnight",
  "theme": {
    "primary": "#6aa6f5",
    "accent": "#5fb0e0",
    "background": "#161616",
    "text": "#e6e9ee"
  }
}

Drop a theme file in ~/.atlas/themes/ and it appears in the picker on next launch.

Plugins & MCP

Extend Atlas with plugins and Model Context Protocol servers to bring your own tools, surfaces, and context.

~/.atlas/config.json
{
  "mcp": {
    "github": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-github"]
    }
  }
}
Warning
MCP servers can read and write outside your repository. Only add servers you trust, and scope their credentials tightly.
Keybindings

Atlas is keyboard-first. The essentials:

tabSwitch between agents
ctrl pOpen the command palette
enterSubmit the current prompt
escCancel a running task
ctrl cQuit Atlas
Commands

Open the command palette with ctrl p, or type a slash command directly into the prompt.

/initGenerate a project guide Atlas reads on every run
/modelSwitch the active model or provider
/themeOpen the theme picker
/planDraft a plan before any edits are made
/clearStart a fresh session in the same directory
/helpList every available command
CLI flags

Atlas accepts flags on launch for scripting and one-shot runs.

--prompt <text>Run a single prompt and auto-submit on launch
--model <id>Override the default model for this session
--cwd <path>Open Atlas in a specific directory
--versionPrint the installed version and exit
Troubleshooting

The atlas command is not found

Restart your shell so the updated PATH takes effect, or re-run the install script. On Windows, reopen the terminal as well.

The wordmark looks garbled

Atlas uses block glyphs and truecolor. Use a modern terminal with a Nerd Font and 24-bit color enabled.

Still stuck?
Open an issue on GitHub or email hello@syntora.io.

Ready to ship?

Install Atlas and open it in your next repo.

Install