explainthisrepo 0.22.0 → 0.22.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
_The fastest way to understand any codebase in plain English using real project signals. Not blind AI summarization._
|
|
4
4
|
|
|
5
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 does and how it is organized in plain English.
|
|
6
|
+
This is a deterministic repo signal extractor that feeds LLMs correctly.
|
|
6
7
|
|
|
7
8
|
[](https://pypi.org/project/explainthisrepo/)
|
|
8
9
|
[](https://pepy.tech/projects/explainthisrepo)
|
|
@@ -23,7 +24,7 @@ Not blind AI summarization.
|
|
|
23
24
|
- Speeds up understanding of unfamiliar codebases
|
|
24
25
|
- Extract architecture signals from configs, entrypoints, and manifests
|
|
25
26
|
- Works with GitHub repositories, local directories, private repositories, individual files and monorepos
|
|
26
|
-
- Outputs the explanation to an `EXPLAIN.md` file in your current directory
|
|
27
|
+
- 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`, `.docs`)
|
|
27
28
|
- Multiple explanation modes (quick, simple, detailed)
|
|
28
29
|
|
|
29
30
|
## Installation
|
|
@@ -345,7 +346,7 @@ When analyzing a file:
|
|
|
345
346
|
|
|
346
347
|
### Custom output
|
|
347
348
|
|
|
348
|
-
|
|
349
|
+
`--output`, `-o` → Specify output file or directory (default: `EXPLAIN.md`)
|
|
349
350
|
|
|
350
351
|
Write to a specific file:
|
|
351
352
|
|
|
Binary file
|