codebase-guide
github.com/dimitritholen/codebase-guide- Category
- Developer Tools
- Rank
- No. 3021Tools index
Previous survey · No. 2844 ·
- Type
- TOOL
- Use case
- Coding
- Interfaces
- Agent Skill / Plugin
- GitHub
- 1 stars
- Date
About
codebase-guide is a Claude Code plugin that reads a repository and writes a single-file HTML onboarding guide. The guide explains what the project does, its main parts, how a request moves through the code, and which file to open for a given change. Diagrams are drawn from the actual code and the file opens offline in any browser.
At a glance
codebase-guide turns a repository into a single HTML onboarding guide through Claude Code. It is worth trying when a newcomer needs to see how the main parts fit together before they start tracing files.
Good fit
Maintainers with a repository they can share with their Claude Code configuration and a teammate who can verify the generated walkthrough.
Consider something else when
Pass if you need documentation that stays in sync automatically or a reference precise enough to substitute for the code.
Start here
Generate a guide for a small repository and ask a newcomer to trace one request from entry point to storage. Compare the path and symbols with the source before sharing the file.
Cost and requirements
Requires Claude Code and Python 3. The default design export also needs Node. Generation uses your Claude session, while the finished HTML can be read offline.
Limits to know
Treat the output as a snapshot. Check it after architectural changes and review the guide for sensitive implementation details before sending it outside the team.
Sources checked 2026-11-05. Source-based assessment.
Tags
Comments (0)
No comments yet
Editorially curated, with community endorsements as a secondary signal. Corrections welcome.