explainthisrepo 0.25.0 → 0.25.3
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 +32 -0
- package/dist/native/win-x64/explainthisrepo.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -43,6 +43,7 @@ explainthisrepo owner/repo
|
|
|
43
43
|
# explainthisrepo ./path/to/directory
|
|
44
44
|
# explainthisrepo ./path/to/file.py
|
|
45
45
|
# explainthisrepo owner/repo/path/to/file.py
|
|
46
|
+
# explainthisrepo owner/repo/path/to/directory
|
|
46
47
|
```
|
|
47
48
|
|
|
48
49
|
Alternatively,
|
|
@@ -87,6 +88,7 @@ explainthisrepo owner/repo
|
|
|
87
88
|
# explainthisrepo ./path/to/directory
|
|
88
89
|
# explainthisrepo ./path/to/file.py
|
|
89
90
|
# explainthisrepo owner/repo/path/to/file.py
|
|
91
|
+
# explainthisrepo owner/repo/path/to/directory
|
|
90
92
|
</details>
|
|
91
93
|
</pre>
|
|
92
94
|
</code>
|
|
@@ -104,6 +106,7 @@ npx explainthisrepo owner/repo
|
|
|
104
106
|
# npx explainthisrepo ./path/to/directory
|
|
105
107
|
# npx explainthisrepo ./path/to/file.py
|
|
106
108
|
# npx explainthisrepo owner/repo/path/to/file.py
|
|
109
|
+
# npx explainthisrepo owner/repo/path/to/directory
|
|
107
110
|
</code>
|
|
108
111
|
</pre>
|
|
109
112
|
</details>
|
|
@@ -216,6 +219,7 @@ explainthisrepo github.com/owner/repo
|
|
|
216
219
|
explainthisrepo https://github.com/owner/repo/issues/123
|
|
217
220
|
explainthisrepo https://github.com/owner/repo?tab=readme
|
|
218
221
|
explainthisrepo git@github.com:owner/repo.git
|
|
222
|
+
explainthisrepo owner/repo/path/to/directory
|
|
219
223
|
explainthisrepo owner/repo/path/to/file.py
|
|
220
224
|
explainthisrepo .
|
|
221
225
|
explainthisrepo ./path/to/directory
|
|
@@ -399,6 +403,34 @@ This is different from local file analysis:
|
|
|
399
403
|
```bash
|
|
400
404
|
explainthisrepo ./path/to/file.py
|
|
401
405
|
```
|
|
406
|
+
|
|
407
|
+
## GitHub Directory Analysis
|
|
408
|
+
|
|
409
|
+
ExplainThisRepo can analyze a specific directory inside a GitHub repository without cloning it.
|
|
410
|
+
|
|
411
|
+
```bash
|
|
412
|
+
explainthisrepo owner/repo/path/to/directory
|
|
413
|
+
```
|
|
414
|
+
Supports all explanation modes:
|
|
415
|
+
```bash
|
|
416
|
+
explainthisrepo owner/repo/path/to/directory --quick
|
|
417
|
+
explainthisrepo owner/repo/path/to/directory --simple
|
|
418
|
+
explainthisrepo owner/repo/path/to/directory --detailed
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
When analyzing a GitHub directory:
|
|
422
|
+
|
|
423
|
+
- Directory contents are fetched via the GitHub API
|
|
424
|
+
|
|
425
|
+
- Only structure and metadata are used (no full repo fetch)
|
|
426
|
+
|
|
427
|
+
- Signals include files, subdirectories, and extension distribution
|
|
428
|
+
|
|
429
|
+
- The explanation focuses on the directory’s role and structure
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
`--stack` is not supported for directory targets.
|
|
433
|
+
|
|
402
434
|
### Custom output
|
|
403
435
|
|
|
404
436
|
`--output`, `-o` → Specify output file or directory (default: `EXPLAIN.md`)
|
|
Binary file
|