Ultra-fast multithreaded repository scanner and health inspector CLI tools built in Rust

Quick 1-Liner Installation (No Rust / Cargo Required)

Install binary directly from GitHub Releases without needing Rust toolchains or Visual Studio Build Tools:

Windows (PowerShell)

irm https://raw.githubusercontent.com/caya8205-2/ferrum-scan/main/install.ps1 | iex

Linux / macOS (Bash)

curl -fsSL https://raw.githubusercontent.com/caya8205-2/ferrum-scan/main/install.sh | bash

---

Features

• Ultra-Fast Repository Scanner: Scans project directories in parallel within milliseconds using rayon and ignore. Respects .gitignore, .ignore, and automatically skips .git, node_modules, target, and hidden directories by default.
• Repository Insights & Health Rating: Evaluates overall repository health, documentation ratio, Git status, and assigns an overall health score (e.g., A+ (Optimal & Clean)).
• Storage Breakdown (--storage, -s): Analyzes disk space consumption across top subdirectories to identify storage hogs.
• Duplicate Files Detector (--duplicates, -d): Finds identical duplicate files across the repository using fast parallel content hashing and calculates total wasted storage space.
• Full Scan Option (--full): Bypasses ignore rules to scan all files.
• Language Breakdown & Metrics: Computes exact Lines of Code (LOC), blank lines, and comment lines per programming language.
• Git Health Inspector: Analyzes total commits, active contributors, top contributors, and last commit dates.
• Jumbo File Detector: Flags large files exceeding a customizable threshold (default 5MB).
• Terminal Visuals & Export: Formats statistics in clean terminal tables using comfy-table and supports exporting reports to Markdown (SCAN_REPORT.md) or JSON.

Real-World Benchmark

Check out a real-world full benchmark report scanning 34,000+ files and 5.5 Million+ lines of code:

👉 View Full SCAN_REPORT.md

Build from Source

Build

cargo build --release

Global Install via Cargo

cargo install --path .

Usage

Scan Current Directory (Default)

ferrum-scan

Storage Breakdown Analysis

ferrum-scan --storage
# or short flag:
ferrum-scan -s

Duplicate Files Detection & Wasted Space Calculation

ferrum-scan --duplicates
# or short flag:
ferrum-scan -d

Combine Storage, Duplicate, and Full Analysis

ferrum-scan --full -s -d

Scan Specific Path

ferrum-scan /path/to/repository

Export Report to Markdown

ferrum-scan export --format md --output SCAN_REPORT.md -s -d

License

This project is licensed under the MIT License.