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
Copy file name to clipboardExpand all lines: README.md
+26-30Lines changed: 26 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# ExplainThisRepo
2
2
3
-
_The fastest way to understand any codebase in plain English using real project signals. Not blind AI guessing._
3
+
_The fastest way to understand any unfamiliar codebase using real project signals. Not blind AI guessing. Signals first. LLM second_
4
4
5
-
ExplainThisRepo analyzes real project signals; configs, entrypoints, manifests, dependencies graph, file structure and high-signal files producing a clear, structured `EXPLAIN.md` that explains what the codebase actually does and how it is organized in plain English.
5
+
ExplainThisRepo analyzes real project signals; configs, entrypoints, manifests, dependencies graph, structures and high-signal files producing a clear, structured `EXPLAIN.md` that shows you what the codebase actually does, how it is organized, where to start, what to ignore, and what matters before touching unfamiliar codebases.
- Derives architectural summaries from repository structure and code signals.
21
-
Not blind AI guessing
22
-
- Deterministic repo signal extractor that feeds LLMs correctly. Signals first. LLM second
23
-
- Translates complex code structures into plain English
20
+
- System map that shows you where to start, what to ignore, what matters and why
21
+
- Deterministic repo signal extractor that feeds LLMs correctly.
24
22
- Speeds up understanding of unfamiliar codebases
25
23
- Solves the "**garbage in, garbage out**" problem specifically for codebases
26
-
- Extract architecture signals from configs, entrypoints, and manifests
27
-
- System map that shows you where to start, what matters and what to ignore
28
-
- Works with GitHub repositories, Local repositories, GitHub directories, local directories, GitHub files and local files
24
+
- Multiple modes (quick, simple, detailed) that translates complex repository structure and code signals into architectural summaries. Not blind AI guessing. Signals first. LLM second
25
+
- Works with GitHub repositories, local repositories, GitHub directories, local directories, GitHub files and local files
29
26
- Supports private repositories and monorepos
30
27
- Zero-cloning and remote analysis
28
+
- Extract architecture signals from configs, entrypoints, and manifests
31
29
- Outputs the explanation to an `EXPLAIN.md` file in your current directory, prints it directly in the terminal, or a specified output file (`.txt`, `.pdf`, `.docx`, `.md`)
0 commit comments