explainthisrepo 0.5.1 → 0.6.1

package/README.md

@@ -1,6 +1,6 @@
 # ExplainThisRepo
 
-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.
+ExplainThisRepo is a CLI that generates plain-English explanations of any codebase (GitHub repositories and local directories) by analyzing project structure, README content, and high signal files.
 
 It helps developers quickly understand unfamiliar codebases by deriving architectural explanations from real project structure and code signals, producing a clear, structured `EXPLAIN.md`.
 

package/dist/cli.js

@@ -7,6 +7,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { Command } from "commander";
 import ora from "ora";
+import { runInit } from "./init.js";
 import { fetchRepo, fetchReadme } from "./github.js";
 import { buildPrompt, buildQuickPrompt, buildSimplePrompt } from "./prompt.js";
 import { generateExplanation } from "./generate.js";
@@ -133,9 +134,9 @@ async function main() {
     const program = new Command();
     program
         .name("explainthisrepo")
-        .description("Explain GitHub repositories in plain English")
+        .description("CLI that generates plain English explanations of any codebase")
         .version(getPkgVersion(), "-v, --version", "Show version")
-        .argument("[repository]", "GitHub repository (owner/repo or URL) or local path")
+        .argument("[repository]", "GitHub repository (owner/repo or URL) or local directories")
         .option("--doctor", "Run diagnostics")
         .option("--quick", "Quick summary mode")
         .option("--simple", "Simple summary mode")
@@ -155,7 +156,16 @@ Examples:
   $ explainthisrepo ./path/to/directory
   $ explainthisrepo . --stack
   $ explainthisrepo --doctor`);
+    program
+        .command("init")
+        .description("Initialize configuration with Gemini API key")
+        .action(async () => {
+        await runInit();
+    });
     program.parse(process.argv);
+    if (process.argv[2] === "init") {
+        return;
+    }
     const options = program.opts();
     const repository = program.args[0];
     if (options.doctor) {
@@ -173,7 +183,7 @@ Examples:
         process.exit(1);
     }
     if (!repository) {
-        program.error("repository argument required");
+        program.error("repository argument required (or use `init` to set up API key)");
     }
     const local = fs.existsSync(repository);
     let owner = "";

package/dist/config.d.ts

@@ -0,0 +1,4 @@
+export declare function getConfigPath(): string;
+export declare function ensureConfigDir(): string;
+export declare function writeConfig(contents: string): void;
+export declare function readConfig(): string | null;

package/dist/config.js

@@ -0,0 +1,33 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+const CONFIG_DIR_NAME = "ExplainThisRepo";
+const CONFIG_FILE_NAME = "config.toml";
+export function getConfigPath() {
+    if (process.platform === "win32") {
+        const appdata = process.env.APPDATA;
+        if (!appdata) {
+            throw new Error("APPDATA environment variable is not set");
+        }
+        return path.join(appdata, CONFIG_DIR_NAME, CONFIG_FILE_NAME);
+    }
+    const xdg = process.env.XDG_CONFIG_HOME;
+    const base = xdg ?? path.join(os.homedir(), ".config");
+    return path.join(base, "explainthisrepo", CONFIG_FILE_NAME);
+}
+export function ensureConfigDir() {
+    const configPath = getConfigPath();
+    const dir = path.dirname(configPath);
+    fs.mkdirSync(dir, { recursive: true });
+    return configPath;
+}
+export function writeConfig(contents) {
+    const path = ensureConfigDir();
+    fs.writeFileSync(path, contents, { encoding: "utf-8" });
+}
+export function readConfig() {
+    const path = getConfigPath();
+    if (!fs.existsSync(path))
+        return null;
+    return fs.readFileSync(path, "utf-8");
+}

package/dist/init.d.ts

@@ -0,0 +1 @@
+export declare function runInit(): Promise<void>;

package/dist/init.js

@@ -0,0 +1,45 @@
+import readline from "node:readline";
+import process from "node:process";
+import chalk from "chalk";
+import { writeConfig } from "./config.js";
+const CONFIG_TEMPLATE = `[llm]
+provider = "gemini"
+api_key = "{api_key}"
+`;
+export async function runInit() {
+    const err = process.stderr;
+    err.write(chalk.yellow("WARNING: input is hidden. Paste your GEMINI_API_KEY and press Enter.\n\n"));
+    try {
+        const apiKey = (await promptHidden("Gemini API key: ")).trim();
+        if (!apiKey) {
+            err.write(chalk.red("error: API key cannot be empty\n"));
+            process.exit(1);
+        }
+        writeConfig(CONFIG_TEMPLATE.replace("{api_key}", apiKey));
+        err.write("\r");
+        err.write("\x1b[2K");
+        err.write(chalk.green("Configuration written.\n"));
+        process.exit(0);
+    }
+    catch {
+        err.write(chalk.red("\nInterrupted.\n"));
+        process.exit(130);
+    }
+}
+function promptHidden(label) {
+    const err = process.stderr;
+    return new Promise((resolve) => {
+        err.write(label);
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: undefined,
+            terminal: true,
+        });
+        rl._writeToOutput = () => { };
+        rl.question("", (answer) => {
+            rl.close();
+            err.write("\n");
+            resolve(answer);
+        });
+    });
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "explainthisrepo",
-  "version": "0.5.1",
-  "description": "A CLI developer tool to explain any GitHub repository in plain English",
+  "version": "0.6.1",
+  "description": "CLI that generates plain English explanations of any codebase",
   "license": "MIT",
   "type": "module",
   "author": "Caleb Wodi <calebwodi33@gmail.com>",