You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -12,6 +12,33 @@ You're staring at a codebase you didn't write — maybe thousands of files acros
12
12
13
13
Codedocent parses the codebase into a navigable, visual block structure and explains each piece in plain English. It's an AI code analysis tool — use a cloud provider for speed or run locally through Ollama for full privacy. Point it at any codebase and get a structural overview you can explore interactively, understand quickly, and share as a static HTML file.
14
14
15
+
## What's new in v1.0.0
16
+
17
+
### Architecture Mode
18
+
19
+
Visualize your codebase as a zoomable dependency graph. Three levels of detail:
20
+
21
+
-**Level 0 — Modules**: See all modules as nodes with dependency edges between them
22
+
-**Level 1 — Files**: Drill into a module to see its files and their internal + external dependencies
23
+
-**Level 2 — Code**: Click through to the existing CodeDocent file view (functions, classes, complexity)
24
+
25
+
Export MD button at each level generates structured context you can feed to AI tools.
26
+
27
+
```bash
28
+
codedocent /path/to/code --arch # jump straight to architecture view
29
+
```
30
+
31
+
Or choose option 4 in the setup wizard.
32
+
33
+
### Enhanced AI Summaries
34
+
35
+
AI analysis now understands where each file sits in the system:
36
+
37
+
-**Dependency context** — the prompt tells the AI what this file imports and what imports it
38
+
-**ROLE** — what job does this code do? Foundation, orchestrator, utility, entry point?
39
+
-**KEY CONCEPTS** — main functions, classes, and data structures with one-line descriptions
40
+
-**Better prompts** — explains code in terms of data flow and system role, not just syntax
41
+
15
42
## Who this is for
16
43
17
44
-**Developers onboarding onto an unfamiliar codebase** — get oriented in minutes instead of days
@@ -23,7 +50,9 @@ Codedocent parses the codebase into a navigable, visual block structure and expl
23
50
24
51
## What you see
25
52
26
-
Nested, color-coded blocks representing directories, files, classes, and functions — the entire structure of a codebase laid out visually. Each block shows a plain English summary, a pseudocode translation, and quality warnings (green/yellow/red). Click any block to drill down; breadcrumbs navigate you back up. You can export code from any block or paste replacement code back into the source file. AI explanations come from your choice of cloud provider or local Ollama.
53
+
Nested, color-coded blocks representing directories, files, classes, and functions — the entire structure of a codebase laid out visually. Each block shows a plain English summary, key concepts, pseudocode, and quality warnings. Click any block to drill down; breadcrumbs navigate you back up. You can export code from any block or paste replacement code back into the source file.
54
+
55
+
In architecture mode, a D3.js force-directed graph shows modules and files as nodes with directed dependency edges. Click any node to drill deeper.
27
56
28
57
## Install
29
58
@@ -38,6 +67,7 @@ Requires Python 3.10+. Cloud AI needs an API key set in an env var (e.g. `OPENAI
38
67
```bash
39
68
codedocent # setup wizard — walks you through everything
Parses code structure with tree-sitter, scores quality with static analysis, and sends individual blocks to a cloud AI provider or local Ollama model for plain English summaries and pseudocode. Interactive mode analyzes on click — typically 1-2 seconds per block. Full mode analyzes everything upfront into a self-contained HTML file you can share.
80
+
Parses code structure with tree-sitter, scores quality with static analysis, and sends individual blocks to a cloud AI provider or local Ollama model for plain English summaries and pseudocode. Interactive mode analyzes on click — typically 1-2 seconds per block. Full mode analyzes everything upfront into a self-contained HTML file you can share. Architecture mode builds a dependency graph from import statements and renders it as a zoomable D3 visualization.
0 commit comments