quackstack 1.0.11 → 1.0.12

package/README.md

@@ -4,6 +4,8 @@
 
 QuackStack is an interactive CLI tool that indexes your codebase using local AI embeddings and lets you ask questions about it conversationally. Perfect for understanding unfamiliar code, onboarding to new projects, or giving your AI coding assistant persistent context.
 
+## 🎯 Quack in Action!
+Check out the QuackStack Live demo [here](https://courageous-spaniel.clueso.site/share/4f5e6395-8ad8-4d18-8e81-f736a6581a25)!
 ## ✨ Features
 
 * 🚀 **Zero-config** - Just run `quack` in any project directory
@@ -272,4 +274,4 @@ MIT
 
 **Large Codebases**: First index might take a few minutes. After that, only changed files are re-indexed.
 
-**No Vendor Lock-in**: Unlike other tools, QuackStack works with Cursor, Windsurf, Cline, Continue, and Aider - choose your favorite!
+**No Vendor Lock-in**: Unlike other tools, QuackStack works with Cursor, Windsurf, Cline, Continue, and Aider - choose your favorite!

package/dist/cli.cjs

@@ -8,6 +8,7 @@ const commander_1 = require("commander");
 const chalk_animation_1 = __importDefault(require("chalk-animation"));
 const repl_js_1 = require("./repl.js");
 const context_generator_js_1 = require("./lib/context-generator.js");
+const readme_js_1 = require("./commands/readme.js");
 const path_1 = __importDefault(require("path"));
 const program = new commander_1.Command();
 const PROJECT_NAME = path_1.default.basename(process.cwd());
@@ -18,12 +19,17 @@ program
     .option("-r, --reindex", "Force reindex the codebase")
     .option("-c, --context", "Generate context files for ALL AI coding tools (Cursor, Windsurf, Cline, Continue, Aider)")
     .option("-d, --docs", "Generate CODEBASE.md - universal documentation for any IDE/editor")
+    .option("--readme", "Generate README.md from your codebase")
     .option("--cursor", "[DEPRECATED] Use --context instead. Generates .cursorrules only")
     .option("-w, --watch", "Watch mode: auto-update context files on file changes")
     .action(async (options) => {
     const title = chalk_animation_1.default.rainbow("Welcome to QuackStack! 🐥\n");
     await new Promise(res => setTimeout(res, 1500));
     title.stop();
+    if (options.readme) {
+        await (0, readme_js_1.generateReadme)(PROJECT_NAME);
+        process.exit(0);
+    }
     if (options.context) {
         await (0, context_generator_js_1.generateContextFiles)(PROJECT_NAME);
         await (0, context_generator_js_1.updateGlobalContext)(PROJECT_NAME);

package/dist/commands/readme.js

@@ -0,0 +1,101 @@
+import { client } from "../lib/database.js";
+import { getAIClient } from "../lib/ai-provider.js";
+import fs from "fs/promises";
+import path from "path";
+import readline from "readline";
+async function askQuestion(query) {
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    return new Promise(resolve => {
+        rl.question(query, answer => {
+            rl.close();
+            resolve(answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes');
+        });
+    });
+}
+export async function generateReadme(projectName, outputPath) {
+    const readmePath = outputPath || path.join(process.cwd(), "README.md");
+    const exists = await fs.access(readmePath).then(() => true).catch(() => false);
+    if (exists) {
+        const shouldOverwrite = await askQuestion("⚠️  README.md already exists. Overwrite? (y/n): ");
+        if (!shouldOverwrite) {
+            console.log("Cancelled.");
+            return;
+        }
+    }
+    const snippets = await client.codeSnippet.findMany({
+        where: { projectName },
+    });
+    const fileStructure = [...new Set(snippets.map(s => s.filePath))].sort();
+    const technologies = detectTechnologies(snippets);
+    const entryPoints = findEntryPoints(snippets);
+    const context = `
+Project Structure:
+${fileStructure.map(f => `- ${f}`).join('\n')}
+
+Technologies Detected:
+${technologies.join(', ')}
+
+Entry Points:
+${entryPoints.map(e => `- ${e.filePath} (${e.functionName})`).join('\n')}
+
+Sample Code Snippets:
+${snippets.slice(0, 10).map(s => `
+File: ${s.filePath}
+${s.content.slice(0, 200)}...
+`).join('\n---\n')}
+  `;
+    const aiClient = getAIClient();
+    const prompt = `
+You are a technical documentation expert. Based on the following codebase context, generate a comprehensive README.md file.
+
+Include:
+- Project title and description
+- Technologies used
+- Installation instructions
+- Usage examples
+- Project structure overview
+- Key features
+- Contributing guidelines (basic)
+
+Make it professional, clear, and actionable.
+
+Context:
+${context}
+`;
+    console.log("🦆 Generating README.md...");
+    const readme = await aiClient.generateAnswer(prompt, context);
+    await fs.writeFile(readmePath, readme, "utf-8");
+    console.log(`✅ README.md generated at ${readmePath}`);
+}
+function detectTechnologies(snippets) {
+    const techs = new Set();
+    snippets.forEach(s => {
+        const filePath = s.filePath.toLowerCase();
+        if (filePath.endsWith('.tsx') || filePath.endsWith('.jsx'))
+            techs.add('React');
+        if (filePath.endsWith('.ts'))
+            techs.add('TypeScript');
+        if (filePath.endsWith('.py'))
+            techs.add('Python');
+        if (filePath.endsWith('.rs'))
+            techs.add('Rust');
+        if (filePath.includes('prisma'))
+            techs.add('Prisma');
+        if (s.content.includes('express'))
+            techs.add('Express');
+        if (s.content.includes('fastapi'))
+            techs.add('FastAPI');
+        if (s.content.includes('django'))
+            techs.add('Django');
+    });
+    return Array.from(techs);
+}
+function findEntryPoints(snippets) {
+    return snippets.filter(s => s.filePath.includes('main') ||
+        s.filePath.includes('index') ||
+        s.filePath.includes('app') ||
+        s.functionName?.toLowerCase().includes('main')).slice(0, 5);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quackstack",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "description": "Your cracked unpaid intern for all things codebase related! AI-powered codebase search and Q&A.",
   "type": "module",
   "main": "dist/cli.cjs",