explainthisrepo 0.4.4 → 0.5.1

package/README.md

@@ -1,8 +1,8 @@
 # ExplainThisRepo
 
-ExplainThisRepo is a CLI that generates plain-English explanations of public GitHub repositories by analyzing repository structure, README content, and selected high signal files.
+ExplainThisRepo is a CLI that generates plain-English explanations of public GitHub repositories and local directories by analyzing project structure, README content, and high signal files.
 
-It's helps developers understand unfamiliar repositories does by generating a structured `EXPLAIN.md` from real
+It helps developers quickly understand unfamiliar codebases by deriving architectural explanations from real project structure and code signals, producing a clear, structured `EXPLAIN.md`.
 
 [![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)
@@ -19,15 +19,15 @@ It's helps developers understand unfamiliar repositories does by generating a st
 
 ## 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
+- Generates architectural summaries from repository structure and code signals
+- Fetches public repositories by GitHub URLs (with or without https), `owner/repo` format, issue links, query strings, and SSH clone links
+- Analyzes 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
+- Detects programming languages with the GitHub API
+- Analyzes local project directories using the same pipeline as GitHub repositories
 - Generates a structured plain English explanation grounded in actual project files
-- Outputs an EXPLAIN.md file in your current directory (default mode)
+- Outputs the explanation to an `EXPLAIN.md` file in your current directory or print it directly in the terminal
 - Multi mode command-line interface
 
 ---
@@ -38,13 +38,13 @@ It's helps developers understand unfamiliar repositories does by generating a st
 
 - `--quick` → One-sentence summary
 
-- `--simple` → Short, easy explanation
+- `--simple` → Short, simplified explanation
 
 - `--detailed` → Deeper explanation including structure and architecture
 
 - `--stack` → Tech stack breakdown from repo signals
 
-- `--version` → Show CLI version
+- `--version` → Check installed CLI version
 
 - `--help` → Show usage guide
 
@@ -56,9 +56,9 @@ It's helps developers understand unfamiliar repositories does by generating a st
 
 ExplainThisRepo uses Gemini models for code analysis.
 
-Set your API key as an environment variable.
+Set your Google Gemini API key as an environment variable.
 
-macOS / Linux
+Linux / macOS
 
 ```bash
 export GEMINI_API_KEY="your_api_key_here"
@@ -74,7 +74,7 @@ Restart your terminal after setting the key.
 
 ## Installation
 
-### Option 1: install via pip (recommended):
+### Option 1: install with pip (recommended):
 
 Requirements: Python 3.9+
 
@@ -99,29 +99,32 @@ explainthisrepo owner/repo
 # or: npx explainthisrepo owner/repo
 ```
 
+Replace `owner/repo` with the GitHub repository identifier (e.g., `facebook/react`).
+
 ---
 
-## Flexible Repository Input
+## Flexible Repository and Local Directory Input
 
-You don’t need to reformat links anymore.
+Accepts various formats for repository input, full GitHub URLs, issue links, and SSH clone links.
 
-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
+explainthisrepo .
+explainthisrepo ./path/to/directory
 ```
 
-All inputs are normalized internally to owner/repo.
+All inputs are normalized internally to `owner/repo`.
 
 ---
 
 ## Usage
 
 ### Basic
-Generate a full explanation and saves it to `EXPLAIN.md`:
+Writes a full explanation to `EXPLAIN.md`:
 
 ```bash
 explainthisrepo owner/repo
@@ -134,7 +137,8 @@ explainthisrepo facebook/react
 
 ### Quick mode
 
-Get a one-sentence definition (prints only, no file created):
+Prints a one-sentence summary to stdout:
+
 ```bash
 explainthisrepo owner/repo --quick
 ```
@@ -148,7 +152,8 @@ explainthisrepo facebook/react --quick
 
 ### Detailed mode
 
-Generate a more detailed explanation (includes architecture / folder structure):
+Writes a more detailed explanation of repository structure and architecture:
+
 ```bash
 explainthisrepo owner/repo --detailed
 ```
@@ -159,7 +164,8 @@ explainthisrepo owner/repo --detailed
 
 ### Simple mode
 
-Prints only the simple output (no EXPLAIN.md)
+Prints a short, simplified explanation to stdout. No files are written.
+
 ```bash
 explainthisrepo owner/repo --simple
 ```
@@ -170,15 +176,43 @@ explainthisrepo owner/repo --simple
 
 ### Stack detector
 
-Get a tech stack breakdown detected from repo signals. No AI explanation. Prints only.
+Tech stack breakdown detected from repo signals. No LLM calls are made.
+
 ```bash
 explainthisrepo owner/repo --stack
 ```
 ![Stack detector Output](assets/stack-command-output.png)
 
+### Local Directory Analysis
+
+ExplainThisRepo can analyze local directories directly in the terminal, using the same modes and output formats as GitHub repositories
+
+```bash
+explainthisrepo .
+explainthisrepo ./path/to/directory
+```
+
+This works with all existing modes:
+
+```bash
+explainthisrepo . --quick
+explainthisrepo . --simple
+explainthisrepo . --detailed
+explainthisrepo . --stack
+```
+
+When analyzing a local directory:
+- Repository structure is derived from the filesystem
+- Key files (README, configs, entrypoints) are extracted locally
+- No GitHub APIs calls are made
+- All prompts and outputs remain identical
+
+This allows analysis of projects directly from the local filesystem, without requiring a GitHub repository.
+
 ### Version
 
-Print the installed version:
+Print the installed CLI version:
+
 ```bash
 explainthisrepo --version
 ```
@@ -187,12 +221,13 @@ explainthisrepo --version
 
 ### Doctor
 
-Check environment + connectivity (useful for debugging):
+Check environment and connectivity (useful for debugging):
+
 ```bash
 explainthisrepo --doctor
 ```
 
-## Termux (Android) install notes
+### Termux (Android) install notes
 
 Termux has some environment limitations that can make `pip install explainthisrepo` fail to create the `explainthisrepo` command in `$PREFIX/bin`.
 
@@ -216,7 +251,7 @@ If you do not want to modify PATH, you can run ExplainThisRepo as a module:
 python -m explain_this_repo owner/repo
 ```
 
-Gemini support on Termux (Optional)
+### Gemini support on Termux (Optional)
 
 Installing Gemini support may require building Rust-based dependencies on Android, which can take time on first install:
 
@@ -247,4 +282,4 @@ Caleb Wodi
 
 - Email: caleb@explainthisrepo.com
 - Twitter: [@calchiwo](https://x.com/calchiwo)
-- LinkedIn: [@calchiwo](https://linkedin.com/in/calchiwo)
+- LinkedIn: [@calchiwo](https://linkedin.com/in/calchiwo)

package/dist/cli.js

@@ -1,15 +1,18 @@
 #!/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";
 import { Command } from "commander";
+import ora from "ora";
 import { fetchRepo, fetchReadme } from "./github.js";
 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 +25,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 +86,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 +135,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 +151,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,27 +175,17 @@ Examples:
     if (!repository) {
         program.error("repository argument required");
     }
-    let owner, repo;
-    try {
-        ({ owner, repo } = resolveRepoTarget(repository));
-    }
-    catch (e) {
-        const message = e instanceof Error ? e.message : String(e);
-        console.error(`error: ${message}`);
-        process.exit(1);
+    const local = fs.existsSync(repository);
+    let owner = "";
+    let repo = "";
+    let localPath = "";
+    if (local) {
+        localPath = path.resolve(repository);
+        console.log(`Analyzing local directory: ${repository}`);
     }
-    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);
@@ -200,49 +193,125 @@ Examples:
             process.exit(1);
         }
     }
-    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) {
+            const spinner = ora("Reading repository files…").start();
+            try {
+                read = readLocalRepoSignalFiles(localPath);
+                spinner.stop();
+            }
+            catch (e) {
+                spinner.stop();
+                const message = e instanceof Error ? e.message : String(e);
+                console.error(`error: ${message}`);
+                process.exit(1);
+            }
+        }
+        else {
+            const spinner = ora(`Fetching ${owner}/${repo}…`).start();
+            try {
+                languages = await fetchLanguages(owner, repo);
+                read = await readRepoSignalFiles(owner, repo);
+                spinner.stop();
+            }
+            catch (e) {
+                spinner.stop();
+                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) {
+        const spinner = ora(`Fetching ${owner}/${repo}…`).start();
+        try {
+            repoData = await fetchRepo(owner, repo);
+            readme = await fetchReadme(owner, repo);
+            spinner.stop();
+        }
+        catch (e) {
+            spinner.stop();
+            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.quick) {
-        const prompt = buildQuickPrompt(repoData.full_name, repoData.description, readme);
-        console.log("Generating explanation...");
-        const output = await generateWithExit(prompt);
+        let quickReadme = readme;
+        const repoName = local ? localPath : (repoData?.full_name ?? "");
+        const description = local ? null : (repoData?.description ?? null);
+        if (local) {
+            const spinner = ora("Reading repository files…").start();
+            try {
+                const read = readLocalRepoSignalFiles(localPath);
+                spinner.stop();
+                const readmeKey = Object.keys(read.keyFiles).find((k) => k.toLowerCase().startsWith("readme"));
+                quickReadme = readmeKey !== undefined ? read.keyFiles[readmeKey] : null;
+            }
+            catch (e) {
+                spinner.stop();
+                throw e;
+            }
+        }
+        const prompt = buildQuickPrompt(repoName, description, quickReadme);
+        const spinner = ora("Generating explanation…").start();
+        const output = await generateWithExit(prompt).finally(() => spinner.stop());
         console.log("Quick summary 🎉");
         console.log(output.trim());
         return;
     }
     if (options.simple) {
-        const readResult = await safeReadRepoFiles(owner, repo);
-        const prompt = buildSimplePrompt(repoData.full_name, repoData.description, readme, readResult?.treeText ?? null);
-        console.log("Generating explanation...");
-        const output = await generateWithExit(prompt);
+        let readResult;
+        const spinner = ora("Reading repository files…").start();
+        try {
+            readResult = local
+                ? readLocalRepoSignalFiles(localPath)
+                : await safeReadRepoFiles(owner, repo);
+            spinner.stop();
+        }
+        catch (e) {
+            spinner.stop();
+            throw e;
+        }
+        const prompt = buildSimplePrompt(local ? localPath : (repoData?.full_name ?? ""), local ? null : (repoData?.description ?? null), local ? null : readme, readResult?.treeText ?? null);
+        const genSpinner = ora("Generating explanation…").start();
+        const output = await generateWithExit(prompt).finally(() => genSpinner.stop());
         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);
-    console.log("Generating explanation...");
-    const output = await generateWithExit(prompt);
+    let readResult;
+    const readSpinner = ora("Reading repository files…").start();
+    try {
+        readResult = local
+            ? readLocalRepoSignalFiles(localPath)
+            : await safeReadRepoFiles(owner, repo);
+        readSpinner.stop();
+    }
+    catch (e) {
+        readSpinner.stop();
+        throw e;
+    }
+    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);
+    const genSpinner = ora("Generating explanation…").start();
+    const output = await generateWithExit(prompt).finally(() => genSpinner.stop());
     console.log("Writing EXPLAIN.md...");
     writeOutput(output);
     const wordCount = output.split(/\s+/).filter(Boolean).length;

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.4",
+  "version": "0.5.1",
   "description": "A CLI developer tool to explain any GitHub repository in plain English",
   "license": "MIT",
   "type": "module",
@@ -47,7 +47,8 @@
     "@google/generative-ai": "^0.24.1",
     "axios": "^1.13.2",
     "commander": "^14.0.3",
-    "dotenv": "^17.2.3"
+    "dotenv": "^17.2.3",
+    "ora": "^9.3.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",