RepoAtlasv0.2.1 • Open Source
HomeDocsGetting Started

Introduction to RepoAtlas

RepoAtlas transforms any repository into beautiful, configurable, documentation-ready visual project structures.

3 min read•Updated July 22, 2026
Quick Package Installation
$
npm install @repoatlasdev/cli

RepoAtlas is an open-source developer platform designed to make software repositories readable, understandable, and visually stunning.

It is NOT just another CLI tree command — it's the Prettier + ESLint equivalent for repository visualization.

Why RepoAtlas?

Traditional tree output lacks contextual icons, theme palettes, Markdown formatting, and exporter plugins. RepoAtlas provides:

  • 🚀 High-Throughput Core — Scans 100,000+ files in sub-milliseconds using async filesystem APIs
  • 🎨 Multi-Theme Engine — Render in VSCode, Material, Unicode, Nerd Font, ASCII, Markdown, and Mermaid
  • 📦 13 Exporter Formats — Export trees to md, html, json, yaml, xml, csv, docx, pdf, svg, png, and mermaid
  • 🤖 AI Prompt Generator — Compress repo trees into token-optimized context for LLMs
  • ⚡ VSCode & GitHub Action — Visualize in VS Code Explorer or auto-commit in CI/CD workflows

Core Data Pipeline

Every repository scan in RepoAtlas moves strictly through a unidirectional architecture:

Filesystem → Scanner → Tree Model → Transformer → Renderer → Exporter → Output

This ensures clean separation of concerns and allows every layer to be independently extended via plugins.

Package Ecosystem

PackageDescription
@repoatlasdev/coreScanner, parser, TreeNode model
@repoatlasdev/renderersMulti-theme rendering engine
@repoatlasdev/exportersFormat exporters (Markdown, Mermaid, JSON, etc.)
@repoatlasdev/iconsIcon pack mapping & symbol lookup
@repoatlasdev/configConfig file loader
@repoatlasdev/detectorFramework & language detection
@repoatlasdev/utilsPure functional utilities
@repoatlasdev/cliCommand-line interface

Quick Start

Install the CLI globally and generate your first structure:

bash
1npm install -g @repoatlasdev/cli 2 3# Generate a tree visualization 4repo-atlas generate ./my-project 5 6# Generate with a specific theme 7repo-atlas generate ./my-project --theme material --icons emoji 8 9# Export as Markdown 10repo-atlas generate ./my-project --theme markdown --output PROJECT_STRUCTURE.md
Next
CLI Reference
Edit page on GitHub