Workspace scan
Walks the file system, skips dependency and build directories, and identifies languages, manifests, entry points, and source roots.
VS Code extension
v0.3.0
MIT
Explain This Project
A VS Code extension that analyzes an open codebase and generates a structured
PROJECT_OVERVIEW.md with languages, frameworks, entry points, directory structure,
and git history insights.
01 · Why it exists
Every unfamiliar repository has the same first questions.
When you open a new codebase, the first work is orientation. What stack is this? Where does it start? Which directories matter? What parts change often? Explain This Project turns that first pass into a repeatable local analysis.
The extension writes a project overview at the root so the next person, or the next AI coding session, has a useful map before touching code.
How it works
Static analysis first, narrative summary only when requested.
Framework detection
Parses common manifests and configuration files to identify frameworks and tooling across JavaScript, Python, Rust, Go, PHP, Java, and C# projects.
Git history insights
When git is available, adds churn hotspots, bug clusters, contributor activity, and other repository signals.
Optional AI summary
Can send the generated markdown to GitHub Copilot or OpenAI for a plain-English narrative. The core scan does not require that step.
02 · Commands
Three commands cover the normal workflow.
| Command | What it does |
|---|---|
Explain This Project |
Generates or refreshes PROJECT_OVERVIEW.md for the current workspace. |
Explain This Project (Force) |
Regenerates the overview even when a previous output already exists. |
Explain This Project: Ask Questions |
Uses the generated overview as context for project questions when AI support is configured. |
03 · Privacy
The useful part does not need a network call.
File scanning, manifest parsing, framework detection, source tree rendering, and git history analysis run locally inside VS Code. No account or API key is required for the generated overview.
AI summary features are optional. If GitHub Copilot is unavailable or no OpenAI key is configured, the extension still produces the static project overview.
Keep exploring