whaojie797-design/codebase-brief

README 摘要

codebase-brief Run one command, get the codebase map your next engineer actually needs. 一条命令，生成新成员 10 分钟就能读懂的代码库入门包。 codebase-brief turns a stranger repository into a structured engineering onboarding pack — with sources, unknowns, and a Mermaid architecture map. It is deterministic static analysis : no LLM, no network, no uploads, no guessing. Supported in v0.1.0: Python, TypeScript/JavaScript, Docker Compose . Any other language is reported as UNKNOWN — never faked as supported. Demo / 演示 Real output of python scripts/scan repo.py tests/fixtures/ts-monorepo , rendered as a terminal recording: (Swap docs/demo.gif for a longer screen recording if you prefer; the frames above are rendered from a real scan.) What it produces File Purpose CODEBASE BRIEF.md What it is, how to run, core modules, key deps, risks ARCHITECTURE MAP.md Mermaid module graph; every edge tagged EXTRACTED / INFERRED with source ONBOARDING.md Local start, tests, minimal first-change path OPEN QUESTIONS.md Only what static analysis CANNOT confirm codebase-inventory.json Machine-readable inventory for tooling/CI Every confirmed claim cites a file path. Inferences are labeled INFERRED . Unknowns go to OPEN QUESTIONS…

分类