What is Codedocent?
Codedocent is a guided tour of any codebase. You point it at a project folder and it generates an interactive visualization in your browser — nested colored blocks representing the structure of the code, from directories down to individual functions. Click any block to expand it. Turn on AI analysis and each block gets a plain English explanation of what it does.
It's built for people who need to understand code but don't write it: project managers, founders, hardware engineers, designers, technical writers, or anyone evaluating an open source project before committing to it.
Key features
- Interactive visualization — Nested colored blocks you can click to drill into. Directories, files, classes, functions — all visible at a glance.
- AI-powered explanations — Local AI (via Ollama) generates plain English summaries of what each piece of code does. No jargon.
- Code quality indicators — Color-coded warnings flag overly complex or oversized code blocks so you can spot problem areas without reading a line.
- Runs locally — Everything stays on your machine. No cloud, no API keys, no code ever leaves your computer.
- Shareable output — Generates a single self-contained HTML file. Email it to anyone and they can open it in a browser.
- GUI or terminal — Use the graphical launcher or the command line. Both work.
- Setup wizard — Run
codedocentwith no arguments and it walks you through everything.
Quick start
###b class="inline-flex items-center justify-center relative shrink-0 can-focus select-none disabled:pointer-events-none disabled:opacity-50 disabled:shadow-none disabled:drop-shadow-none border-transparent transition font-base duration-300 ease-[cubic-bezier(0.165,0.85,0.45,1)] h-8 w-8 rounded-md active:scale-95 backdrop-blur-md Button_ghost__BUAoh" type="button" aria-label="Copy to clipboard" data-state="closed"###
pip install codedocent codedocent
That's it. The wizard handles the rest.
Requirements
- Python 3.10+
- Ollama installed locally (for AI features — the tool works without it, you just won't get the English explanations)
Brandon
Reed Foster
Robin Reiter
Edward Li
Alexander R Pruss