Quickstart
Point Atlas at a frontend project and it maps every reusable asset, the dependency graph, your npm inventory and everything nothing uses any more — in one command, with nothing to configure.
Run it
Atlas needs Node 20 or newer and a React / Next.js / Vite / TypeScript project. There is nothing to install and nothing to sign up for — the whole analysis runs locally.
Scan and open the dashboard
From your project root, run the one command that does everything: analyze, cache, serve, open.
npx codebase-atlas serveNot sure where to start? Run atlas on its own for an interactive menu
of every command.
Start with Overview
The dashboard opens on Overview: asset counts, the framework and routers Atlas detected, and your most-reused assets. It's the fastest read on the shape of an unfamiliar codebase.
Search before you build
Hit the search field and type what you're about to write — modal, debounce, formatCurrency.
Every component, hook, util, context, store and route is indexed by name, path and signature. From the
terminal, the same index is one command away:
atlas search modalClean up what nothing uses
Dead code lists exports nothing imports, files no one references, and likely duplicate implementations. It's the cheapest cleanup pass you'll run all quarter.
atlas dead-codeShare it with the team
atlas export writes a self-contained static bundle — the dashboard plus a data snapshot — that you
can host on GitHub Pages, Netlify, S3 or an internal box.
atlas export --out-dir ../atlas-siteLet AI write the docs (optional)
If you have Claude Code, Codex or Cursor installed, Atlas can have it write a sharper one-line description for every asset — batched, resumable, and shown in the dashboard with a source badge.
atlas aiKeep it fresh
Run atlas watch alongside your dev server and the analysis re-runs incrementally as you edit. The
cache means later runs only touch files that actually changed.
Try it on the demo app
The repository ships a small sample app with every asset kind in it:
git clone https://github.com/Yash-Sakre/atlas.git
npx codebase-atlas serve --root atlas/packages/cli/examples/sample-appWhat you get
Every run writes a plain-JSON snapshot to .atlas/ — see the output reference.
Nothing is uploaded, no API keys are needed, and descriptions are generated offline from real AST
facts. If you want richer prose, let a coding agent describe them on purpose with atlas ai.