explainthisrepo 0.21.0 → 0.22.5

package/README.md

@@ -3,6 +3,7 @@
 _The fastest way to understand any codebase in plain English using real project signals. Not blind AI summarization._
 
 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.
+This is a deterministic repo signal extractor that feeds LLMs correctly.
 
 [![PyPI Version](https://img.shields.io/pypi/v/explainthisrepo?color=blue)](https://pypi.org/project/explainthisrepo/)
 [![PyPI Downloads](https://static.pepy.tech/personalized-badge/explainthisrepo?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/explainthisrepo)
@@ -22,8 +23,8 @@ Not blind AI summarization.
 - Translates complex code structures into plain English
 - Speeds up understanding of unfamiliar codebases
 - Extract architecture signals from configs, entrypoints, and manifests
-- Works with GitHub repositories, local directories, private repositories, and monorepos
-- Outputs the explanation to an `EXPLAIN.md` file in your current directory or prints it directly in the terminal
+- Works with GitHub repositories, local directories, private repositories, individual files and monorepos
+- 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`)
 - Multiple explanation modes (quick, simple, detailed)
 
 ## Installation
@@ -182,6 +183,8 @@ For step-by-step instructions, see [docs/GITHUB_TOKEN.md](docs/GITHUB_TOKEN.md)
 
 - `--llm` → Override provider selection
 
+- `--output` / `-o` → Specify output file or directory (default: `EXPLAIN.md`)
+
 ## Flexible Repository and Local Directory Input
 
 Accepts various formats for repository input, full GitHub URLs (with or without https), `owner/repo` format, issue links, query strings, and SSH clone links
@@ -318,6 +321,50 @@ When analyzing a local directory:
 
 This allows analysis of projects directly from the local filesystem, without requiring a GitHub repository.
 
+
+## File Analysis
+
+ExplanThisRepo analyzes individual files directly
+
+```bash
+explainthisrepo ./path/to/file.py
+```
+
+Supports all explanation modes:
+
+```bash
+explainthisrepo ./file.py --quick
+explainthisrepo ./file.py --simple
+explainthisrepo ./file.py --detailed
+```
+
+When analyzing a file:
+- The file is read safely with encoding and size limits
+- Structure and basic signals (size, lines, type) are extracted
+- The explanation focuses on purpose, logic, and behavior
+- This makes it easy to understand unfamiliar files without scanning entire repositories.
+
+### Custom output
+
+`--output`, `-o` → Specify output file or directory (default: `EXPLAIN.md`)
+
+Write to a specific file:
+
+```bash
+explainthisrepo owner/repo --output notes.md
+```
+
+Write to a nested path:
+```bash
+explainthisrepo owner/repo --output path/to/file.md
+```
+
+Write to a directory (creates EXPLAIN.md inside):
+
+```bash
+explainthisrepo owner/repo --output path/to/directory
+```
+
 ### Version
 
 Check the installed CLI version:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "explainthisrepo",
-  "version": "0.21.0",
+  "version": "0.22.5",
   "description": "The fastest way to understand any codebase in plain English. Not blind AI summarization",
   "license": "MIT",
   "type": "module",