Documentation
Build with Atlas
Everything you need to install, configure, and get the most out of the terminal-native AI coding agent.
curl -fsSL https://runatlas.sh/install | shAtlas 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.
Atlas ships as a single binary with no runtime to babysit. Pick the method that fits your platform.
macOS & Linux
curl -fsSL https://runatlas.sh/install | shHomebrew
brew install syntora/tap/atlasWindows (PowerShell)
irm https://runatlas.sh/install.ps1 | iexatlas --version to confirm Atlas is on your PATH.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.
cd ~/code/your-project
atlas
› Add a health check endpoint to the APIAtlas 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.
atlas --prompt "fix the failing tests" and Atlas submits it on open.Atlas reads an optional config file from ~/.atlas/config.json. Project-level overrides live in atlas.json at your repository root.
{
"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).
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.
{
"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.
Extend Atlas with plugins and Model Context Protocol servers to bring your own tools, surfaces, and context.
{
"mcp": {
"github": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"]
}
}
}Atlas is keyboard-first. The essentials:
| tab | Switch between agents |
| ctrl p | Open the command palette |
| enter | Submit the current prompt |
| esc | Cancel a running task |
| ctrl c | Quit Atlas |
Open the command palette with ctrl p, or type a slash command directly into the prompt.
| /init | Generate a project guide Atlas reads on every run |
| /model | Switch the active model or provider |
| /theme | Open the theme picker |
| /plan | Draft a plan before any edits are made |
| /clear | Start a fresh session in the same directory |
| /help | List every available command |
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 |
| --version | Print the installed version and exit |
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.
Ready to ship?
Install Atlas and open it in your next repo.