Skip to content

tecnolgd/repoScanner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

110 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

repoScanner is a lightweight repository analysis tool for developers.

  • Quickly understand your codebase structure, dependencies, and metrics with a single command.
  • Built for developers with the intent of saving time and peace-of-mind

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.

Build Instructions

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

Tool Execution/Run

  • For Quick Summary (Recommended)
python3.12 -m repoScan.cli /path/to/repo #default mode(stats / nerd)

or

python3.12 -m repoScan.cli /path/to/repo --stats #or --nerd
  • For 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

Detects and maps 40+ extensions to human-readable names, including:

  • Systems: C, C++, Rust, Go, Zig, Swift
  • Web: HTML, CSS, JavaScript, TypeScript, PHP
  • Data: JSON, YAML, TOML, SQL, XML
  • Scripting: Python, Ruby, Lua, Shell, PowerShell
  • ...and many more. (Unrecognized extensions fall back to their raw string format).

Beta Status ⚠️

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

Documentation

Contributors

A huge thanks to the developers contributing to repoScanner.

Author & Version

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

Packages

 
 
 

Contributors

Languages