Installation
Atlas is a single CLI published to npm as codebase-atlas. Run it on demand with npx, or install it globally if you use it every day.
Run without installing
The fastest path — npx fetches the package, analyzes the current project and opens the dashboard.
npx codebase-atlas serveInstall globally
Installing globally gives you the atlas binary directly, which is worth it once you're running it
across several repos.
npm i -g codebase-atlas
atlas serveAdd it to a project
You can also keep it as a dev dependency so the whole team runs the same version — useful when you wire
atlas analyze into CI.
npm i -D codebase-atlas
npx atlas analyzeRequirements
- Node 20 or newer. Atlas relaunches itself with a larger V8 heap on big repos, so full type-aware scans don't run out of memory.
- A TypeScript or JavaScript frontend. React, Next.js (app or pages router), Vite, React Router and TanStack Router are all detected automatically.
- Nothing else. No config file, no API key, no network access — see Configuration only if the defaults don't fit your layout.
What it writes
atlas analyze writes its output and the incremental cache to .atlas/ in the project root. Add that
folder to .gitignore unless you deliberately want to diff snapshots in version control. serve and
export write nothing into the project — they cache under ~/.atlas/.
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.
Configuration
Atlas is zero-config by design — every key here is optional. Reach for a config file only when the defaults don't match your layout.