Project and Module Overview Generator

Problem

When taking over an unfamiliar repo, a README often says what the system can do, but not how components divide work, where to start reading, or how critical request paths flow. project-overview-generator organizes code structure, entrypoints, dependencies, and representative flows into an engineer-facing Markdown overview, reducing the preparation cost before reading source code.

How It Works

• Scope detection: determines whether the input is a local path or a Git URL, then selects project-level or module-level analysis.
• Structure extraction: identifies language, framework, entrypoints, core directories, core functions/classes, and module dependencies.
• Document generation: produces architecture, key flows, real code snippets, and Mermaid diagrams; module mode also lists the public API and upstream callers.

Boundaries

It is not a code audit, security scan, or performance analysis tool. Output quality depends on naming, comments, directory conventions, and repository visibility. Private repositories need accessible credentials. Module documentation does not assume the module can start standalone, and details that cannot be inferred from code are marked as pending.