explainthisrepo 0.4.3 → 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Caleb Wodi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,87 +1,250 @@
 # ExplainThisRepo
 
-This folder contains a high-performance, lightweight port of the ExplainThisRepo CLI tool.
-While the original Python implementation is the primary version of this tool, this Node.js port was created to provide a "zero-compilation" experience for users where Python C-extensions (like Pillow) can be difficult to build.
+ExplainThisRepo is a CLI that generates plain-English explanations of public GitHub repositories by analyzing repository structure, README content, and selected high signal files.
 
-## Features
-- **Automated Repository Analysis**: Seamlessly fetches repository data and documentation via the GitHub REST API.
-- **AI-Driven Contextualization**: Uses Google Gemini 2.5 Flash Lite to extract technical value and purpose from codebases.
-- **Senior Engineer Perspective**: Generates explanations tailored for developers, focusing on architecture, target audience, and execution.
-- **Markdown Generation**: Automatically outputs a clean, structured `EXPLAIN.md` file for immediate reading.
-- **TypeScript Core**: Built with type safety and modern asynchronous patterns for reliable performance.
+It's helps developers understand unfamiliar repositories does by generating a structured `EXPLAIN.md` from real
+
+[![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)
+[![Python](https://img.shields.io/pypi/pyversions/explainthisrepo?logo=python&logoColor=white)](https://pypi.org/project/explainthisrepo/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/explainthisrepo)](https://www.npmjs.com/package/explainthisrepo)
+[![Node](https://img.shields.io/node/v/explainthisrepo)](https://www.npmjs.com/package/explainthisrepo)
+[![Docs](https://img.shields.io/badge/docs-explainthisrepo.com-black)](https://explainthisrepo.com)
+
+---
+
+![demo](https://github.com/user-attachments/assets/837e0593-db64-4657-8855-bb1915011eb6)
+---
+
+## Key Features
+
+- Understand unfamiliar repositories instantly through structural and architechural summaries by turning structure and code signals into a readable architectural summary
+- Fetches public GitHub repositories automatically
+- Analyzes real repository data including file tree, configs, entrypoints, and high signal source files
+- Extracts repo signals from key files (package.json, pyproject.toml, config files, entrypoints)
+- Builds a file tree summary to understand project architecture
+- Detects programming languages via the GitHub API
+- Accepts repositories via owner/repo, GitHub URLs (with or without https), issue links, query strings, and SSH clone links
+- Generates a structured plain English explanation grounded in actual project files
+- Outputs an EXPLAIN.md file in your current directory (default mode)
+- Multi mode command-line interface
+
+---
+
+## Modes
+
+- (no flag) → Full repository explanation written to EXPLAIN.md
+
+- `--quick` → One-sentence summary
+
+- `--simple` → Short, easy explanation
+
+- `--detailed` → Deeper explanation including structure and architecture
+
+- `--stack` → Tech stack breakdown from repo signals
+
+- `--version` → Show CLI version
+
+- `--help` → Show usage guide
+
+- `--doctor` → Check environmental health and API connectivity
+
+---
+
+## Configuration
+
+ExplainThisRepo uses Gemini models for code analysis.
+
+Set your API key as an environment variable.
+
+macOS / Linux
+
+```bash
+export GEMINI_API_KEY="your_api_key_here"
+```
+
+Windows (PowerShell)
+
+```bash
+setx GEMINI_API_KEY "your_api_key_here"
+```
+
+Restart your terminal after setting the key.
 
 ## Installation
 
-Follow these steps to set up the project locally on your machine:
+### Option 1: install via pip (recommended):
+
+Requirements: Python 3.9+
+
+```bash
+pip install explainthisrepo
+explainthisrepo owner/repo
+```
 
-1. **Clone the Repository**
-   ```bash
-   git clone https://github.com/calchiwo/ExplainThisRepo.git
-   cd ExplainThisRepo/node_version
-   ```
+Alternatively,
 
-2. **Install Dependencies**
-   ```bash
-   npm install
-   ```
+```bash
+pipx install explainthisrepo
+explainthisrepo owner/repo
+```
 
-3. **Set Up Environment Variables**
-   Create a `.env` file in the root directory or export the variable directly in your terminal:
-   ```bash
-   export GEMINI_API_KEY=your_actual_api_key_here
-   ```
+### Option 2: Install with npm
 
-4. **Build the Project**
-   Compile the TypeScript source code into executable JavaScript:
-   ```bash
-   npm run build
-   ```
-5  **Link the command globally:**
+Install globally and use forever:
 ```bash
-   npm link
-   ```
+npm install -g explainthisrepo
+explainthisrepo owner/repo
+# or: npx explainthisrepo owner/repo
+```
+
+---
 
+## Flexible Repository Input
+
+You don’t need to reformat links anymore.
+
+ExplainThisRepo accepts GitHub repositories the way you actually copy them.
+```bash
+explainthisrepo https://github.com/owner/repo
+explainthisrepo github.com/owner/repo
+explainthisrepo https://github.com/owner/repo/issues/123
+explainthisrepo https://github.com/owner/repo?tab=readme
+explainthisrepo git@github.com:owner/repo.git
+```
+
+All inputs are normalized internally to owner/repo.
+
+---
 
 ## Usage
 
-Once the project is built, you can use the CLI tool to analyze any public GitHub repository.
+### Basic
+Generate a full explanation and saves it to `EXPLAIN.md`:
+
+```bash
+explainthisrepo owner/repo
+```
+Example:
+```bash
+explainthisrepo facebook/react
+```
+---
+
+### Quick mode
+
+Get a one-sentence definition (prints only, no file created):
+```bash
+explainthisrepo owner/repo --quick
+```
+Example:
+```bash
+explainthisrepo facebook/react --quick
+```
+![Quick Mode Output](assets/quick-command-output.png)
+
+---
+
+### Detailed mode
+
+Generate a more detailed explanation (includes architecture / folder structure):
+```bash
+explainthisrepo owner/repo --detailed
+```
+
+![Detailed Mode Output](assets/detailed-command-output.png)
 
-### Running the CLI
-Execute the tool by passing the `owner/repo` string as an argument:
+---
 
+### Simple mode
+
+Prints only the simple output (no EXPLAIN.md)
+```bash
+explainthisrepo owner/repo --simple
+```
+
+![Simple Mode Output](assets/simple-command-output.png)
+
+---
+
+### Stack detector
+
+Get a tech stack breakdown detected from repo signals. No AI explanation. Prints only.
 ```bash
-node dist/cli.js facebook/react
+explainthisrepo owner/repo --stack
 ```
+![Stack detector Output](assets/stack-command-output.png)
+
+### Version
 
-### Expected Workflow
-1. The tool fetches the repository description and README from GitHub.
-2. It processes the information and sends a structured prompt to the Gemini AI.
-3. An `EXPLAIN.md` file is generated in your current working directory containing:
-   - Project Overview
-   - Functional Breakdown
-   - Target User Identification
-   - Setup/Execution Instructions
+Print the installed version:
+```bash
+explainthisrepo --version
+```
 
-### Scripts
-- `npm run build`: Compiles TypeScript to the `dist` folder.
-- `npm run format`: Formats the codebase using Prettier.
-- `npm start`: Runs the tool (requires the repository argument).
+---
 
-## Contributing
+### Doctor
 
-Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
+Check environment + connectivity (useful for debugging):
+```bash
+explainthisrepo --doctor
+```
 
--️ **Report Bugs**: Open an issue if you find any unexpected behavior.
-- **Feature Requests**: Proposals for new features are always welcome.
-- **Pull Requests**: Ensure your code follows the existing style and all linting passes.
+## Termux (Android) install notes
 
-> Note: Please run npm run format before submitting a Pull Request to ensure code consistency.
+Termux has some environment limitations that can make `pip install explainthisrepo` fail to create the `explainthisrepo` command in `$PREFIX/bin`.
+
+### Recommended install (Termux)
+
+```bash
+pip install --user -U explainthisrepo
+```
+
+Make sure your user bin directory is on your PATH:
+```bash
+export PATH="$HOME/.local/bin:$PATH"
+```
+> Tip: Add the PATH export to your ~/.bashrc or ~/.zshrc so it persists.
+
+Alternative (No PATH changes)
+
+If you do not want to modify PATH, you can run ExplainThisRepo as a module:
+
+```bash
+python -m explain_this_repo owner/repo
+```
+
+Gemini support on Termux (Optional)
+
+Installing Gemini support may require building Rust-based dependencies on Android, which can take time on first install:
+
+```bash
+pip install --user -U "explainthisrepo[gemini]"
+```
+
+## Contributions
+
+Contributions are welcome!
+
+If you find a bug, have an idea, or want to improve the tool:
+- See [CONTRIBUTING](CONTRIBUTING.md) for setup and guidelines
+- Open an issue for bugs/feature requests
+- Or submit a pull request for fixes/improvements
+
+---
 
 ## License
-This project is licensed under the MIT License as specified in the package configuration.
 
-## Author Info
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Author
 
-[**Caleb Wodi**](https://github.com/calchiwo)
+Caleb Wodi
 
-Node version contibuted by [@Spectra010s](https://github.com/spectra010s)
+- Email: caleb@explainthisrepo.com
+- Twitter: [@calchiwo](https://x.com/calchiwo)
+- LinkedIn: [@calchiwo](https://linkedin.com/in/calchiwo)

package/dist/cli.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 import os from "node:os";
 import process from "node:process";
+import fs from "node:fs";
 import { readFileSync } from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
@@ -10,6 +11,7 @@ import { buildPrompt, buildQuickPrompt, buildSimplePrompt } from "./prompt.js";
 import { generateExplanation } from "./generate.js";
 import { writeOutput } from "./writer.js";
 import { readRepoSignalFiles } from "./repo_reader.js";
+import { readLocalRepoSignalFiles } from "./local_reader.js";
 import { fetchLanguages } from "./github.js";
 import { detectStack } from "./stack-detector.js";
 import { printStack } from "./stack_printer.js";
@@ -22,8 +24,8 @@ function resolveRepoTarget(target) {
         target = target.replace("http//", "http://");
     }
     if (target.startsWith("git@github.com:")) {
-        const path = target.replace("git@github.com:", "");
-        const [owner, repoRaw] = path.split("/", 2);
+        const p = target.replace("git@github.com:", "");
+        const [owner, repoRaw] = p.split("/", 2);
         if (!owner || !repoRaw)
             throw new Error("Invalid GitHub SSH URL");
         return { owner, repo: repoRaw.replace(/\.git$/, "") };
@@ -83,10 +85,7 @@ async function checkUrl(url, timeoutMs = 6000) {
         clearTimeout(t);
         const message = e instanceof Error ? e.message : String(e);
         const name = e instanceof Error ? e.name : "Error";
-        return {
-            ok: false,
-            msg: `failed (${name}: ${message})`,
-        };
+        return { ok: false, msg: `failed (${name}: ${message})` };
     }
 }
 async function runDoctor() {
@@ -135,7 +134,7 @@ async function main() {
         .name("explainthisrepo")
         .description("Explain GitHub repositories in plain English")
         .version(getPkgVersion(), "-v, --version", "Show version")
-        .argument("[repository]", "GitHub repository (owner/repo or URL)")
+        .argument("[repository]", "GitHub repository (owner/repo or URL) or local path")
         .option("--doctor", "Run diagnostics")
         .option("--quick", "Quick summary mode")
         .option("--simple", "Simple summary mode")
@@ -151,6 +150,9 @@ Examples:
   $ explainthisrepo owner/repo --quick
   $ explainthisrepo owner/repo --simple
   $ explainthisrepo owner/repo --stack
+  $ explainthisrepo .
+  $ explainthisrepo ./path/to/directory
+  $ explainthisrepo . --stack
   $ explainthisrepo --doctor`);
     program.parse(process.argv);
     const options = program.opts();
@@ -172,58 +174,86 @@ Examples:
     if (!repository) {
         program.error("repository argument required");
     }
-    let owner, repo;
-    try {
-        ({ owner, repo } = resolveRepoTarget(repository));
+    const local = fs.existsSync(repository);
+    let owner = "";
+    let repo = "";
+    let localPath = "";
+    if (local) {
+        localPath = path.resolve(repository);
+        console.log(`Analyzing local directory: ${repository}`);
     }
-    catch (e) {
-        const message = e instanceof Error ? e.message : String(e);
-        console.error(`error: ${message}`);
-        process.exit(1);
-    }
-    console.log(`Fetching ${owner}/${repo}...`);
-    if (options.stack) {
+    else {
         try {
-            const languages = await fetchLanguages(owner, repo);
-            const read = await readRepoSignalFiles(owner, repo);
-            const report = detectStack({
-                languages,
-                tree: read.tree,
-                keyFiles: read.keyFiles,
-            });
-            printStack(report, owner, repo);
-            return;
+            ({ owner, repo } = resolveRepoTarget(repository));
         }
         catch (e) {
             const message = e instanceof Error ? e.message : String(e);
             console.error(`error: ${message}`);
             process.exit(1);
         }
+        console.log(`Fetching ${owner}/${repo}...`);
     }
-    let repoData;
-    try {
-        repoData = await fetchRepo(owner, repo);
-    }
-    catch (e) {
-        const message = e instanceof Error ? e.message : String(e);
-        console.error("Failed to fetch repository data.");
-        console.error(`error: ${message}`);
-        console.error("\nfix:");
-        console.error("- Ensure the repository exists and is public");
-        console.error("- Or set GITHUB_TOKEN to avoid rate limits");
-        process.exit(1);
+    if (options.stack) {
+        let read;
+        let languages = {};
+        if (local) {
+            read = readLocalRepoSignalFiles(localPath);
+        }
+        else {
+            try {
+                languages = await fetchLanguages(owner, repo);
+                read = await readRepoSignalFiles(owner, repo);
+            }
+            catch (e) {
+                const message = e instanceof Error ? e.message : String(e);
+                console.error(`error: ${message}`);
+                process.exit(1);
+            }
+        }
+        const report = detectStack({
+            languages,
+            tree: read.tree,
+            keyFiles: read.keyFiles,
+        });
+        const label = local ? repository : owner;
+        const sublabel = local ? "" : repo;
+        printStack(report, label, sublabel);
+        return;
     }
+    let repoData = null;
     let readme = null;
-    try {
-        readme = await fetchReadme(owner, repo);
-    }
-    catch (e) {
-        const message = e instanceof Error ? e.message : String(e);
-        console.warn(`Warning: Could not fetch README: ${message}`);
-        readme = null;
+    if (!local) {
+        try {
+            repoData = await fetchRepo(owner, repo);
+        }
+        catch (e) {
+            const message = e instanceof Error ? e.message : String(e);
+            console.error("Failed to fetch repository data.");
+            console.error(`error: ${message}`);
+            console.error("\nfix:");
+            console.error("- Ensure the repository exists and is public");
+            console.error("- Or set GITHUB_TOKEN to avoid rate limits");
+            process.exit(1);
+        }
+        try {
+            readme = await fetchReadme(owner, repo);
+        }
+        catch (e) {
+            const message = e instanceof Error ? e.message : String(e);
+            console.warn(`Warning: Could not fetch README: ${message}`);
+            readme = null;
+        }
     }
     if (options.quick) {
-        const prompt = buildQuickPrompt(repoData.full_name, repoData.description, readme);
+        let quickReadme = readme;
+        const repoName = local ? localPath : (repoData?.full_name ?? "");
+        const description = local ? null : (repoData?.description ?? null);
+        if (local) {
+            const read = readLocalRepoSignalFiles(localPath);
+            const readmeKey = Object.keys(read.keyFiles).find((k) => k.toLowerCase().startsWith("readme"));
+            quickReadme = readmeKey !== undefined ? read.keyFiles[readmeKey] : null;
+        }
+        const prompt = buildQuickPrompt(repoName, description, quickReadme);
         console.log("Generating explanation...");
         const output = await generateWithExit(prompt);
         console.log("Quick summary 🎉");
@@ -231,16 +261,20 @@ Examples:
         return;
     }
     if (options.simple) {
-        const readResult = await safeReadRepoFiles(owner, repo);
-        const prompt = buildSimplePrompt(repoData.full_name, repoData.description, readme, readResult?.treeText ?? null);
+        const readResult = local
+            ? readLocalRepoSignalFiles(localPath)
+            : await safeReadRepoFiles(owner, repo);
+        const prompt = buildSimplePrompt(local ? localPath : (repoData?.full_name ?? ""), local ? null : (repoData?.description ?? null), local ? null : readme, readResult?.treeText ?? null);
         console.log("Generating explanation...");
         const output = await generateWithExit(prompt);
         console.log("Simple summary 🎉");
         console.log(output.trim());
         return;
     }
-    const readResult = await safeReadRepoFiles(owner, repo);
-    const prompt = buildPrompt(repoData.full_name, repoData.description, readme, options.detailed || false, readResult?.treeText ?? null, readResult?.filesText ?? null);
+    const readResult = local
+        ? readLocalRepoSignalFiles(localPath)
+        : await safeReadRepoFiles(owner, repo);
+    const prompt = buildPrompt(local ? localPath : (repoData?.full_name ?? ""), local ? null : (repoData?.description ?? null), local ? null : readme, options.detailed || false, readResult?.treeText ?? null, readResult?.filesText ?? null);
     console.log("Generating explanation...");
     const output = await generateWithExit(prompt);
     console.log("Writing EXPLAIN.md...");

package/dist/local_reader.d.ts

@@ -0,0 +1,2 @@
+import { type RepoReadResult } from "./repo_reader.js";
+export declare function readLocalRepoSignalFiles(dirPath: string): RepoReadResult;

package/dist/local_reader.js

@@ -0,0 +1,77 @@
+import fs from "node:fs";
+import path from "node:path";
+const KEY_FILENAMES = new Set([
+    "readme.md", "readme.txt", "readme.rst", "readme",
+    "package.json", "pyproject.toml", "setup.py", "setup.cfg",
+    "requirements.txt", "cargo.toml", "go.mod", "pom.xml",
+    "build.gradle", "composer.json", "gemfile", "makefile",
+    "dockerfile", "docker-compose.yml", "docker-compose.yaml",
+    ".env.example", "tsconfig.json", "angular.json", "next.config.js",
+    "vite.config.js", "vite.config.ts", "webpack.config.js",
+]);
+const SKIP_DIRS = new Set([
+    ".git", ".hg", ".svn", "node_modules", "__pycache__",
+    ".venv", "venv", "env", ".env", "dist", "build",
+    ".idea", ".vscode", ".mypy_cache", ".pytest_cache",
+    "coverage", ".coverage", "htmlcov",
+]);
+const MAX_FILE_BYTES = 32_000;
+const MAX_KEY_FILES = 12;
+function walkDir(root, dir, tree, keyFiles) {
+    let entries;
+    try {
+        entries = fs.readdirSync(dir, { withFileTypes: true });
+    }
+    catch {
+        return;
+    }
+    const dirs = [];
+    const files = [];
+    for (const entry of entries) {
+        if (entry.isDirectory() && !SKIP_DIRS.has(entry.name)) {
+            dirs.push(entry);
+        }
+        else if (entry.isFile()) {
+            files.push(entry);
+        }
+    }
+    dirs.sort((a, b) => a.name.localeCompare(b.name));
+    files.sort((a, b) => a.name.localeCompare(b.name));
+    for (const file of files) {
+        const absPath = path.join(dir, file.name);
+        const relPath = path.relative(root, absPath).replace(/\\/g, "/");
+        tree.push({ path: relPath, type: "blob" });
+        if (KEY_FILENAMES.has(file.name.toLowerCase()) &&
+            Object.keys(keyFiles).length < MAX_KEY_FILES) {
+            try {
+                const fd = fs.openSync(absPath, "r");
+                const buf = Buffer.alloc(MAX_FILE_BYTES);
+                const bytesRead = fs.readSync(fd, buf, 0, MAX_FILE_BYTES, 0);
+                fs.closeSync(fd);
+                keyFiles[relPath] = buf.subarray(0, bytesRead).toString("utf8");
+            }
+            catch {
+            }
+        }
+    }
+    for (const subdir of dirs) {
+        walkDir(root, path.join(dir, subdir.name), tree, keyFiles);
+    }
+}
+export function readLocalRepoSignalFiles(dirPath) {
+    const root = path.resolve(dirPath);
+    const tree = [];
+    const keyFiles = {};
+    walkDir(root, root, tree, keyFiles);
+    const treeText = tree.map((item) => item.path).join("\n");
+    const filesText = Object.entries(keyFiles)
+        .map(([relPath, content]) => `### ${relPath}\n${content}`)
+        .join("\n\n");
+    return {
+        tree,
+        treeText,
+        keyFiles,
+        filesText,
+        selectedFiles: Object.keys(keyFiles),
+    };
+}

package/dist/repo_reader.d.ts

@@ -1,4 +1,4 @@
-type TreeItem = {
+export type TreeItem = {
     path: string;
     type: "blob" | "tree";
     size?: number;
@@ -11,4 +11,3 @@ export type RepoReadResult = {
     keyFiles: Record<string, string>;
 };
 export declare function readRepoSignalFiles(owner: string, repo: string): Promise<RepoReadResult>;
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "explainthisrepo",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "description": "A CLI developer tool to explain any GitHub repository in plain English",
   "license": "MIT",
   "type": "module",
@@ -37,7 +37,8 @@
   "scripts": {
     "build": "tsc",
     "start": "node dist/cli.js",
-    "prepublishOnly": "npm run build"
+    "sync-meta": "cp ../README.md README.md && cp ../LICENSE LICENSE",
+    "prepublishOnly": "npm run sync-meta && npm run build"
   },
   "engines": {
     "node": ">=20"