Global options

Interactive mode

Run atlas with no command in a terminal and you get a guided menu instead of the help text. It asks which project to scan, then lets you pick what to do — open the dashboard, describe assets with AI, analyze, search, report dead code, print the graph, export a static site or watch for changes — and only asks for what that action needs.

Terminal

$ atlas
┌   atlas  v2.0.0
│
◇  Project to scan
│  .
│
◆  What do you want to do?
│  ● Open the dashboard (analyze + browse in your browser)
│  ○ Describe assets with AI (via Claude Code)
│  ○ Analyze
│  ○ Search assets
│  ○ Dead-code report
│  ○ Dependency graph
│  ○ Export a static site
│  ○ Watch for changes

Press Esc or Ctrl+C at any prompt to cancel. Outside a terminal (pipes, CI) atlas prints its help instead, so scripts never hang on a prompt.

Command aliases

Alias	Same as
`atlas ai`	`atlas describe`
`atlas open`	`atlas serve`
`atlas dead`	`atlas dead-code`

Global flags

Flag	Description
`-v, --version`	Print the installed Atlas version and exit.
`-h, --help`	Show help for Atlas or any subcommand.

Common analysis options

Most analysis commands accept these two on top of their own flags.

Flag	Default	Description
`-r, --root <dir>`	cwd	Project root to analyze. May also be passed positionally, so `atlas serve ./apps/web` and `atlas serve --root ./apps/web` are equivalent.
`-o, --out-dir <dir>`	`.atlas`	Directory for analysis output and the cache, relative to the root.

Getting help in the terminal

Every subcommand documents itself. If you'd rather stay in the shell than in these pages, the CLI will tell you the same thing.

atlas --help
atlas serve --help

Prefer a written reference? Head back to the command pages, or set defaults once in a config file.