A developer's pocket companion for quickly understanding what's inside any project directory. ProjScan scans folders, breaks down file types by extension, counts lines of code, and flags React components that have grown a little too large. No configuration, no fuss, just actionable insight straight from the command line.
flowchart LR
User["User"]
ProjScan["ProjScan CLI"]
FileSystem["File System"]
Output["Terminal Output"]
User --> ProjScan
ProjScan --> FileSystem
ProjScan --> Output
style User fill:#1e1b4b,stroke:#6366f1,stroke-width:2px,color:#fff
style ProjScan fill:#2e1065,stroke:#8b5cf6,stroke-width:2px,color:#fff
style FileSystem fill:#022c22,stroke:#10b981,stroke-width:2px,color:#fff
style Output fill:#451a03,stroke:#f59e0b,stroke-width:2px,color:#fff
You can get ProjScan on your machine in a few different ways.
npm install -g projscan-cliOnce installed, the projscan command is globally available:
Head over to the Releases page and grab the archive for your OS and architecture. Extract it and run the projscan binary.
go install github.com/abubakar-sadiq001/projscan@latest- Clone the repository:
git clone https://github.com/abubakar-sadiq001/projscan.git- Navigate into the project folder:
cd projscan- Build the binary (or install globally with
go install):
go build -o projscan .Now you can run ProjScan from the terminal.
The most common way to use ProjScan is to point it at a directory and let it do its thing.
projscan /path/to/your/projectWhen you're inside the project directory, a simple dot does the trick:
projscan .Want to focus only on certain file types? Pass the -e flag with a comma-separated list.
projscan . -e .go,.tsxPrint the version, commit hash, and build date of your installed binary.
projscan versionOr use the shorthand flag:
projscan -vExample output:
ProjScan v0.1.0
Commit: a1b2c3d
Built: 2026-01-15T10:30:00Z
ProjScan prints a summary that includes:
- Total file counts by extension
- File sizes and line counts
- A list of all files found, ordered by extension, with their individual line counts
- A special section that calls out React components that exceed 300 lines, helping you spot oversized components before they hurt maintainability.
The scan shows an animated spinner while it works, so you know something is happening even on larger projects.
-
Recursive directory scanning – walks through every subdirectory automatically
LoadingsequenceDiagram actor User participant ProjScanCLI as "ProjScan CLI" participant FileSystem User->>ProjScanCLI: projscan ./my-project ProjScanCLI->>ProjScanCLI: Validate directory path ProjScanCLI->>FileSystem: Walk directory tree FileSystem->>ProjScanCLI: Return file entries ProjScanCLI->>ProjScanCLI: Count lines, group by extension, detect large components ProjScanCLI->>User: Print file summary, component warnings, and stats
-
Extension‑based grouping – groups files by extension (.js, .tsx, .go, etc.) for a clear overview
-
Per‑file line counts – shows exactly how many lines of code each file contains
-
Component detection – recognizes files that start with an uppercase letter and have a JS‑like extension, treating them as React components
-
Large component warnings – highlights any component with more than 300 lines, so you can refactor before technical debt piles up
-
Extension filtering – scope the scan to only the file types you care about with a simple CLI flag
-
Human‑readable size formatting – automatically displays sizes in bytes, KB, MB, or GB depending on the magnitude
-
Live scanning spinner – provides real‑time feedback without clutter
-
Built‑in version information – check which release you're running with
projscan versionor the-vflag
| Technology | Description |
|---|---|
| Go | Core language |
| Cobra | CLI framework that handles command parsing and help text |
| progressbar | Library used for the spinner animation (dependency exists but not directly invoked; custom spinner implemented) |
Abubakar Sadiq
- X (Twitter): @scripter_js
