CLI Command Reference
Complete reference for the @repoatlasdev/cli command line tool.
4 min read•Updated July 22, 2026
The @repoatlasdev/cli package provides a fast, predictable CLI tool for generating repository visualizations.
Installation
bash
1# Global install
2npm install -g @repoatlasdev/cli
3
4# Or run with npx (no install)
5npx @repoatlasdev/cli generate .Primary Commands
repo-atlas generate [dir]
Generates a visual repository tree.
| Option | Alias | Description | Default |
|---|---|---|---|
--theme <name> | -t | Rendering theme | unicode |
--icons <pack> | -i | Icon pack | emoji |
--depth <number> | -d | Max recursion depth | 10 |
--sort <type> | -s | Sort strategy (name, size, type) | name |
--only <type> | Filter nodes (all, files, directories) | all | |
--output <file> | -o | Output file path | stdout |
Example:
bash
repo-atlas generate ./my-project --theme vscode --icons material --depth 5 --output STRUCTURE.mdrepo-atlas preview [dir]
Launches a live interactive watcher that re-renders the tree structure in real-time as files change.
bash
repo-atlas preview ./my-project --theme materialrepo-atlas doctor
Executes environment health diagnostics, checking Node version, platform, and registered plugins.
bash
repo-atlas doctorAvailable Themes
| Theme | Description |
|---|---|
unicode | Clean Unicode box-drawing characters |
vscode | VS Code-native file tree style |
material | Material Design icons & colors |
nerd-font | Nerd Font glyphs |
ascii | Classic ASCII pipes & dashes |
markdown | Markdown-formatted nested lists |
json | Structured JSON output |
mermaid | Mermaid.js diagram syntax |
Available Icon Packs
| Pack | Description |
|---|---|
emoji | Colorful emoji icons (📁 📄 ⚙️) |
vscode | VS Code file icons |
material | Material Design file icons |
nerd | Nerd Font devicons |
none | No icons |