🧪 aks-repo-inspector

A simple CLI / library to scan a GitHub repository --- download, analyze folder structure, detect languages, and generate useful reports.

🚀 What it Does

• Clones the repo (shallow clone)  

• Reads file & folder structure (excluding common ignore folders like node_modules, .git, dist, etc.)  

• Detects file-type statistics (extensions, language breakdown)  

• Produces a metadata report with potential stack, package managers, CI config presence, test setup detection, and basic repository summary  

• Generates a human-readable summary file  

• Cleans up cloned repo automatically after report generation

📦 Installation & Usage

You can run it with npx, or install locally / globally.

npx aks-repo-inspector https://github.com/user/project

You can optionally pass flags to control report generation:

Flag Description

--structure  Generate only structure.json

--languages  Generate only languages.json (file-type stats)

--metadata  Generate only metadata.json (stack + analysis)

--ext  Generate only extension-stats.json

--summary  Generate only repo-summary.txt

(no flags)  Generate all reports

Examples

# Full scan (default)

npx aks-repo-inspector https://github.com/vercel/next.js

# Only list file structure

npx aks-repo-inspector https://github.com/user/repo --structure

# Only metadata and summary

npx aks-repo-inspector https://github.com/user/repo --metadata --summary

📁 Generated Reports

- After running, you'll get a folder under /reports/<id>/ containing:

- structure.json --- full file/folder layout

- languages.json --- breakdown of file extensions & counts

- extension-stats.json --- same as languages, with more detail

- metadata.json --- analysis results (detected stack, package managers, CI, tests, etc.)

- repo-summary.txt --- human-readable summary

✅ Requirements & Notes

• Requires git installed on your system (for shallow clone)

• Automatically cleans up cloned repository folder after scan

• Ignores common folders: .git, node_modules, dist, build, .next, etc.

• Works cross-platform (Windows / macOS / Linux)

🛠 Project Structure

aks-repo-inspector/

├── src/

│   ├── index.ts

│   ├── scanner.ts

│   └── utils.ts

├── reports/     # auto-generated

├── package.json

└── tsconfig.json

📄 License

MIT