code-briefy
v1.0.0
Published
A CLI tool that automatically analyzes codebases and generates Markdown summaries using AI.
Maintainers
Readme
santhu-explainer
santhu-explainer is a CLI tool that automatically analyzes your local codebase and generates a beautiful Markdown summary of your project's structure, files, and logic using AI.
Features
- Zero-Config Scanning: Recursively scans the folder you run it in.
- AST Parsing: Parses JavaScript, TypeScript, and JSX using Babel to extract deep structural information offline.
- AI-Powered Summaries: Uses the OpenRouter API to explain your codebase in plain English.
- Offline Fallback: If you have no internet or no API key, it generates a fallback summary using local parsing data.
Installation
Install globally using npm:
npm install -g santhu-explainerSetup
The package is bundled with its own API key in the .env file, so it works out of the box!
Usage
Simply navigate to any project folder and run the command:
cd /path/to/my/project
santhu-explainerThis will analyze your files and drop a project_summary.md file right into the directory!
