repoScanner 0.3.0b5

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

• Directory Analysis: Scan total files, lines of code, average file size, etc.
• 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
• Native File Utilities: Optional vendor/libcvault support adds faster CLI directory scanning, file sorting, search, and byte/line metrics when available.
• Transparent Fallback: If the native helper is missing or unavailable, repoScanner falls back to Python's os.walk and standard-library utilities so the same commands still work.

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)

No Third-Party Python Packages Required

• The core tool uses only the Python Standard Library for normal operation.
• An optional native helper (vendor/libcvault) provides optimized filesystem routines and requires a C++ toolchain and Python development headers to build.
• When the helper is available, repoScanner uses a shared wrapper(repoScan/scanner/libcvault_wrapper.py) to load it once per scanned root and reuse the results; when it is not available, the tool automatically falls back to Python scanning logic.

Benchmarks

These numbers are obtained by testing the commands using hyperfine.

os.path vs std::recursive dir

Modes using libcvault

[!TIP]
For reproducing benchmarks, check benchmarking using hyperfine.

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.

Quick Install

Install directly from PyPI for end users:

pip install repoScanner

Run:

reposcan <path> [--stats|--dev|--help| --bench]

More commnads:

reposcan <path> --sort #sorted list based on byte size
reposcan <path> --search <filename> #search for a file
reposcan <path> --lc <filename> #return line count of a file
reposcan <path> --max #return largest file by size
reposcan <path> --tbytes # return total bytes

Build Instructions

1. Setup

• Clone the repository

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

• Navigate to the directory

  cd repoScanner
  

• Optional: Fetch bundled native helper(libcvault)

  git submodule update --init --recursive vendor/libcvault
  

  • git submodule init registers the submodule in your local repo configuration.
  • git submodule update --init also clones and checks out the correct commit for the submodule.

[!TIP]
If you later want to refresh libcvault from its remote repository, run:

 git submodule update --remote vendor/libcvault

• This updates the submodule to the latest commit from its configured branch. You should then review and commit the updated submodule pointer in the main repo.

Build the native extension from bridge.cpp and vendor/libcvault/main.cpp.

• Before building, make sure system dev packages and pybind11 are available. Debian/Ubuntu example:

  sudo apt-get update
  sudo apt-get install -y build-essential g++ python3-dev
  python3 -m pip install --user pybind11
  

• Compile using pybind11 includes for portability:

  g++ -O3 -shared -std=c++17 -fPIC $(python3 -m pybind11 --includes) -I vendor/libcvault vendor/bridge.cpp vendor/libcvault/main.cpp -o repoScan/libcvault$(python3-config --extension-suffix)
  

[!IMPORTANT]

1. The vendor/libcvault native helper uses Python's C/C++ bindings (pybind11 bridge) for optimized file system operations.
2. Building the helper requires a C++ compiler (e.g., g++) and Python development headers.
3. The native helper is optional. If you prefer zero native dependencies, you can safely add .gitmodules and vendor/ to your .gitignore.

The repository may include a prebuilt binary (e.g. libcvault.cpython-312-x86_64-linux-gnu.so) for convenience; if you plan to distribute, prefer providing prebuilt wheels rather than committing .so artifacts in the repo.

2. Tool Execution/Run

The easiest way to use repoScanner is with the provided shell script wrapper:

./reposcan <path> [--stats|--raw|--dev|--bench]

Quick start:

./reposcan .                       # stats mode
./reposcan /path/to/repo --raw     # detailed developer output
./reposcan /path/to/repo --bench   # benchmark harness

3. 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).

Documentation

• Architecture
• Usage
• Testing
• Roadmap

Contributing

Contributors

A huge thanks to the developers contributing to repoScanner.

• @Ghraven
• @AzarAI-TOP
• @Benjamin Ayiovh

Author & License

• Author: tecnolgd
• License: MIT