██████╗ ███████╗██████╗  ██████╗ ██╗     ███████╗███╗   ██╗███████╗
    ██╔══██╗██╔════╝██╔══██╗██╔═══██╗██║     ██╔════╝████╗  ██║██╔════╝
    ██████╔╝█████╗  ██████╔╝██║   ██║██║     █████╗  ██╔██╗ ██║███████╗
    ██╔══██╗██╔══╝  ██╔═══╝ ██║   ██║██║     ██╔══╝  ██║╚██╗██║╚════██║
    ██║  ██║███████╗██║     ╚██████╔╝███████╗███████╗██║ ╚████║███████║
    ╚═╝  ╚═╝╚══════╝╚═╝      ╚═════╝ ╚══════╝╚══════╝╚═╝  ╚═══╝╚══════╝
                        Repository Intelligence CLI

Your architecture docs are already outdated. RepoLens fixes that.

RepoLens scans your repository, generates living architecture documentation, and publishes it to Notion, Confluence, GitHub Wiki, or Markdown — automatically on every push. Engineers get technical docs. Stakeholders get readable system overviews. Nobody writes a word.

Stable as of v1.0 — API guarantees · Security hardened · v1.5.0

🎬 Demo

Try it now — no installation required. Run npx @chappibunny/repolens demo on any repo for an instant local preview.

▶️ Click to watch on YouTube

🚀 Quick Start (60 seconds)

Step 1: Install

npm install @chappibunny/repolens

Step 2: Initialize (creates config + GitHub Actions workflow)

npx @chappibunny/repolens init

Step 3: Configure Publishing (optional, skip if using Markdown only)

For Notion:

# Edit .env and add:
NOTION_TOKEN=secret_xxx
NOTION_PARENT_PAGE_ID=xxx

For Confluence:

# Edit .env and add:
CONFLUENCE_URL=https://your-company.atlassian.net/wiki
[email protected]
CONFLUENCE_API_TOKEN=your-token
CONFLUENCE_SPACE_KEY=DOCS

Step 4: Publish

npx @chappibunny/repolens publish

Done! Your docs are now live in Notion, Confluence, and/or .repolens/ directory.

🔄 Upgrading from v0.3.0 or earlier? Run npx @chappibunny/repolens migrate to automatically update your workflow files. See MIGRATION.md for details.

📋 What It Generates

11 document types for three audiences — no manual writing required:

| Audience | Documents | |---|---| | Stakeholders (founders, PMs, ops) | Executive Summary · Business Domains · Data Flows | | Everyone | System Overview · Developer Onboarding · Change Impact | | Engineers | Architecture Overview · Module Catalog · API Surface · Route Map · System Map |

Two modes: Deterministic (free, fast, always works) or AI-Enhanced (optional — OpenAI, Anthropic, Azure, Ollama).

✨ Why RepoLens

| | | |---|---| | 🤖 Autonomous | Runs on every push via GitHub Actions — docs stay evergreen | | 👥 Multi-Audience | Technical docs + stakeholder-readable overviews from one scan | | 📤 Multi-Publisher | Notion, Confluence, GitHub Wiki, Markdown — or all four at once | | 🧠 AI-Assisted | Optional AI with zero-hallucination policy (structured context only) | | 🔍 Smart Detection | Frameworks, domains, data flows, dependencies, drift — all automatic | | 🔌 Extensible | Plugin system for custom renderers, publishers, and hooks | | 🛡️ Secure | Secret detection, injection prevention, rate limiting, supply chain hardening | | ⚡ Fast | Handles repos up to 50k files with performance guardrails |

📦 Installation

npm install @chappibunny/repolens

Or try instantly without installing: npx @chappibunny/repolens demo

For alternative methods, see INSTALLATION.md.

🎨 VS Code Extension

View your architecture directly in VS Code — browse modules, visualize dependencies, and explore your codebase structure without leaving the editor.

Install from Marketplace:

ext install CHAPIBUNNY.repolens-architecture

→ Get it on Visual Studio Marketplace

Features:

• 🏗️ Architecture Explorer — Tree view of your system structure
• 📊 Dependency Visualizer — Interactive dependency graphs
• 📁 Module Browser — Navigate modules by domain and function
• 🔍 Command Palette — Quick access to architecture insights
• 📈 System Metrics — Real-time architecture health indicators

The extension reads your .repolens.yml configuration and provides an interactive UI for exploring the documentation that RepoLens generates.

🎓 Onboarding Guide

Step-by-step setup for publishers, AI features, Notion, Confluence, GitHub Wiki, Discord, and CI/CD automation.

→ Full Onboarding Guide

🎮 Commands

| Command | Description | |---|---| | repolens init | Scaffold config + GitHub Actions workflow | | repolens init --interactive | Step-by-step configuration wizard | | repolens publish | Scan, generate, and publish documentation | | repolens demo | Quick local preview — no API keys needed | | repolens doctor | Validate your setup | | repolens watch | Auto-regenerate docs on file changes | | repolens migrate | Upgrade from v0.3.0 workflows (details) | | repolens feedback | Send feedback to the team |

📸 Example Output

System Map with Dependencies

graph LR
    CLI[bin/repolens<br/>1 file] --> Core[src/core<br/>4 files]
    Publishers[src/publishers<br/>6 files] --> Core
    Publishers --> Renderers[src/renderers<br/>4 files]
    Publishers --> Utils[src/utils<br/>10 files]
    Renderers --> Core
    Delivery[src/delivery<br/>1 file] --> Publishers
    Tests[tests<br/>15 files] -. tests .-> CLI
    Tests -. tests .-> Core
    Tests -. tests .-> Publishers
    
    style CLI fill:#9b59b6,color:#fff
    style Core fill:#f39c12,color:#000
    style Publishers fill:#27ae60,color:#fff
    style Renderers fill:#27ae60,color:#fff
    style Delivery fill:#16a085,color:#fff
    style Utils fill:#95a5a6,color:#000
    style Tests fill:#e67e22,color:#fff

System Overview (Technical Profile)

Generated from your package.json:

## Technical Profile

**Tech Stack**: Next.js, React  
**Languages**: TypeScript  
**Build Tools**: Vite, Turbo  
**Testing**: Vitest, Playwright  
**Architecture**: Medium-sized modular structure with 42 modules  
**API Coverage**: 18 API endpoints detected  
**UI Pages**: 25 application pages detected  

Architecture Diff in PRs

When you open a pull request, RepoLens posts:

## 📐 Architecture Diff

**Modules Changed**: 3
**New Endpoints**: 2
**Routes Modified**: 1

### New API Endpoints
- POST /api/users/:id/verify
- GET /api/users/:id/settings

### Modified Routes
- /dashboard → components/Dashboard.tsx (updated)

🔒 Privacy & Security

• Telemetry is opt-in and disabled by default — no code, secrets, or personal data leaves your machine. See TELEMETRY.md.
• Defense-in-depth security — input validation, secret detection (15+ patterns), rate limiting, injection prevention, supply chain hardening. See SECURITY.md.
• Report vulnerabilities to [email protected] (not public issues). Response within 48 hours.

📚 Documentation

| Guide | Description | |---|---| | Onboarding Guide | Step-by-step setup: publishers, AI, Notion, Confluence, Discord | | Configuration | Complete .repolens.yml schema and examples | | Environment Variables | All env vars by publisher and feature | | Architecture | Pipeline diagram, project structure | | Development | Setup, tests (185 across 15 files), release process | | Security | Threat model, secret detection, validation layers | | Telemetry | Opt-in privacy-first usage analytics | | Troubleshooting | Common issues and fixes | | Migration | Upgrading from v0.3.0 or earlier | | Stability | API contract and semver guarantees |

🤝 Contributing

Ways to help:

• Try it out: Install and use in your projects
• Report issues: Share bugs, edge cases, or UX friction
• Request features: Tell us what's missing
• Build plugins: Extend RepoLens with custom renderers and publishers
• Share feedback: repolens feedback

🗺️ Roadmap

v1.0+ features complete — CLI, config schema, and plugin interface are frozen.

Completed:

• [x] VS Code extension (available on Marketplace)

Next:

• [ ] Obsidian publisher
• [ ] GitHub App

See ROADMAP.md for detailed planning.

📄 License

MIT

💬 Support & Contact

• Troubleshooting: TROUBLESHOOTING.md — installation, config, publishing, AI, and CI/CD issues
• Diagnostics: Run npx @chappibunny/repolens doctor to validate your setup
• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: Contact repository maintainers

Made with ❤️ by RepoLens for developers who care about architecture