repoScanner

A lightweight repository analysis tool for developers.

Quickly understand your codebase structure, dependencies, and metrics with a single command.

What It Does

• File Analysis: Scan total files, lines of code, and average file size
• Dependency Detection: Extract and map dependencies (Python imports, C/C++ includes)
• Language Breakdown: See what languages dominate your repo
• Smart Reporting: Choose between quick stats or detailed developer mode
• JSON Export: Machine-readable reports for automation

Features

Dual Reporting Modes

• Stats Mode (default): High-level summary—perfect for a quick glance
• Raw Mode: File-by-file dependency details for developers who need everything

Key Metrics

• Total files and lines of code
• Per-file dependency counts
• Language distribution
• Largest files and most-dependent files
• File mapping with dependencies(for --dev/raw mode)

Requirements

• Python 3.12+ (tested on Ubuntu 24.04 LTS)

The code uses only Python standard libraries and should be compatible with Python 3.10+, but has been officially tested on Python 3.12.

Usage

Clone the Repository

git clone https://github.com/yourusername/repoScanner.git
cd repoScanner

Quick Summary (Recommended)

python3.12 -m repoScan.cli /path/to/repo

or

python3.12 -m repoScan.cli /path/to/repo --stats #or nerd

Detailed Analysis (Developer Mode)

python3.12 -m repoScan.cli /path/to/repo --raw #or --dev

Output

Reports are automatically saved to output/report.json

Supported Languages

• Python (.py) - import detection
• C/C++ (.c, .cpp, .h, .hpp) - #include detection

More languages coming in v0.1.1.

Beta Status ⚠️

This is a beta release. Expect occasional improvements and refinements. Report issues and suggest features as you use it!

More Info

• Architecture
• Roadmap

Contributing

Contributions are welcome! Help make repoScanner better.

Fork & Clone

# Fork on GitHub, then clone your fork
git clone https://github.com/tecnolgd/repoScanner.git

cd repoScanner

Make Changes & Submit PR

1. Create a feature branch: git checkout -b feature/your-feature
2. Commit your changes: git commit -m "feat: description"
3. Push to your fork: git push origin feature/your-feature
4. Open a Pull Request

Ideas for Contribution

• Add language support (JavaScript, Go, Rust, etc.)
• Add HTML report generation
• Add circular dependency detection
• Write tests
• Improve documentation
• Optimise the scan time and memory

Built for developers with the intent of saving time and peace-of-mind

Author & Version

• Author: tecnolgd
• Version: v0.1.0-beta
• License: MIT