Atlas
v2.0.01Built by Yash Sakre

atlas serve

Analyze and open the interactive dashboard.

Usage
atlas serve [root] [options]
atlas open [root] [options]      # alias

Overview

The fastest way to explore a codebase. Atlas runs the full AST analysis (reusing the cache when it can), then starts a local server and opens the React dashboard — search, asset detail, props and params, usage locations, the dependency graph, your npm inventory and the static files you ship, previewed straight from disk.

Nothing is written into your codebase — the analysis is cached under ~/.atlas/. The server is a dependency-free Node http server bound to 127.0.0.1, so it is not exposed to your network. It runs until you stop it with Ctrl+C.

Options

FlagDefaultDescription
-r, --root <dir>cwdProject root to analyze (or pass it positionally).
-p, --port <n>4321Preferred port; Atlas falls back to a free one if it's taken.
--no-openStart the server but do not open the browser automatically.
--reanalyzeIgnore cached analysis and re-scan from scratch.

Examples

# Analyze the current directory and open the dashboard
npx codebase-atlas serve

atlas serve ./apps/web --port 3000

# Force a fresh scan without launching a browser
atlas serve --no-open --reanalyze

See Dashboard views for a tour of what opens.

On this page