explainthisrepo 0.6.0 → 0.6.2

package/README.md

@@ -26,9 +26,9 @@ It helps developers quickly understand unfamiliar codebases by deriving architec
 - Builds a file tree summary to understand project architecture
 - 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 the explanation to an `EXPLAIN.md` file in your current directory or print it directly in the terminal
-- Multi mode command-line interface
+- Generates a structured plain-English explanation grounded in actual project files
+- Outputs the explanation to an `EXPLAIN.md` file in your current directory or prints it directly in the terminal
+- Multi-mode command-line interface
 
 ---
 
@@ -54,9 +54,21 @@ It helps developers quickly understand unfamiliar codebases by deriving architec
 
 ## Configuration
 
-ExplainThisRepo uses Gemini models for code analysis.
+ExplainThisRepo requires a Google Gemini API key for code analysis.
 
-Set your Google Gemini API key as an environment variable.
+### Quick setup (recommended)
+
+Use the built-in `init` command to securely store your API key:
+
+```bash
+explainthisrepo init
+# or npx explainthisrepo init
+```
+> For details about how initialization works, see [INIT.md](INIT.md).
+
+### Environment variable (manual setup)
+
+If you prefer not to use the `init` command, you can also configure the API key using an environment variable
 
 Linux / macOS
 

package/dist/cli.js

@@ -64,9 +64,6 @@ function getPkgVersion() {
         return "unknown";
     }
 }
-function printVersion() {
-    console.log(getPkgVersion());
-}
 function hasEnv(key) {
     const v = process.env[key];
     return Boolean(v && v.trim());
@@ -130,44 +127,7 @@ async function generateWithExit(prompt) {
         process.exit(1);
     }
 }
-async function main() {
-    const program = new Command();
-    program
-        .name("explainthisrepo")
-        .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 directories")
-        .option("--doctor", "Run diagnostics")
-        .option("--quick", "Quick summary mode")
-        .option("--simple", "Simple summary mode")
-        .option("--detailed", "Detailed explanation mode")
-        .option("--stack", "Stack detection mode")
-        .addHelpText("after", `
-Examples:
-  $ explainthisrepo owner/repo
-  $ explainthisrepo https://github.com/owner/repo
-  $ explainthisrepo github.com/owner/repo
-  $ explainthisrepo git@github.com:owner/repo.git
-  $ explainthisrepo owner/repo --detailed
-  $ explainthisrepo owner/repo --quick
-  $ explainthisrepo owner/repo --simple
-  $ explainthisrepo owner/repo --stack
-  $ explainthisrepo .
-  $ 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];
+async function runAnalysis(repository, options) {
     if (options.doctor) {
         const code = await runDoctor();
         process.exit(code);
@@ -182,9 +142,6 @@ Examples:
         console.error("error: only one mode flag can be used at a time");
         process.exit(1);
     }
-    if (!repository) {
-        program.error("repository argument required (or use `init` to set up API key)");
-    }
     const local = fs.existsSync(repository);
     let owner = "";
     let repo = "";
@@ -329,4 +286,46 @@ Examples:
     console.log(`Words: ${wordCount}`);
     console.log("Open EXPLAIN.md to read it.");
 }
-main();
+const program = new Command();
+program
+    .name("explainthisrepo")
+    .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 directories")
+    .option("--doctor", "Run diagnostics")
+    .option("--quick", "Quick summary mode")
+    .option("--simple", "Simple summary mode")
+    .option("--detailed", "Detailed explanation mode")
+    .option("--stack", "Stack detection mode")
+    .addHelpText("after", `
+Examples:
+  $ explainthisrepo owner/repo
+  $ explainthisrepo https://github.com/owner/repo
+  $ explainthisrepo github.com/owner/repo
+  $ explainthisrepo git@github.com:owner/repo.git
+  $ explainthisrepo owner/repo --detailed
+  $ explainthisrepo owner/repo --quick
+  $ explainthisrepo owner/repo --simple
+  $ explainthisrepo owner/repo --stack
+  $ explainthisrepo .
+  $ explainthisrepo ./path/to/directory
+  $ explainthisrepo . --stack
+  $ explainthisrepo --doctor`)
+    .action(async (repository, options) => {
+    if (options.doctor) {
+        const code = await runDoctor();
+        process.exit(code);
+    }
+    if (!repository) {
+        program.error("repository argument required (or use `init` to set up API key)");
+        return;
+    }
+    await runAnalysis(repository, options);
+});
+program
+    .command("init")
+    .description("Initialize configuration with Gemini API key")
+    .action(async () => {
+    await runInit();
+});
+program.parseAsync(process.argv);

package/dist/init.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "explainthisrepo",
-  "version": "0.6.0",
-  "description": "CLI that generates plain English explanations of any codebase",
+  "version": "0.6.2",
+  "description": "CLI that generates plain-English explanations of any codebase",
   "license": "MIT",
   "type": "module",
   "author": "Caleb Wodi <calebwodi33@gmail.com>",