kramscan 0.3.0 → 0.3.1

package/dist/cli.js

@@ -117,7 +117,8 @@ async function showInteractiveMenu() {
                 message: theme_1.theme.cyan("Enter the URL to scan:"),
                 validate: (input) => {
                     try {
-                        new URL(input);
+                        const urlToTest = /^https?:\/\//i.test(input) ? input : `http://${input}`;
+                        new URL(urlToTest);
                         return true;
                     }
                     catch {

package/dist/commands/config.js

@@ -107,8 +107,8 @@ function registerConfigCommand(program) {
                 type: "list",
                 name: "reportFormat",
                 message: "Default report format:",
-                choices: ["word", "json", "txt"],
-                default: config.report.defaultFormat,
+                choices: ["markdown", "word", "json", "txt"],
+                default: config.report.defaultFormat || "markdown",
             },
             {
                 type: "number",

package/dist/commands/dev.js

@@ -25,7 +25,7 @@ function registerDevCommand(program) {
         .option("--no-watch", "Run a single scan without watching (useful for CI)")
         .action(async (url, options) => {
         // Resolve target URL
-        const targetUrl = url || (options.port ? `http://localhost:${options.port}` : null);
+        let targetUrl = url || (options.port ? `http://localhost:${options.port}` : null);
         if (!targetUrl) {
             console.log("");
             console.log(theme_1.theme.error("✗ No target URL specified."));
@@ -34,6 +34,9 @@ function registerDevCommand(program) {
             console.log("");
             process.exit(1);
         }
+        if (!/^https?:\/\//i.test(targetUrl)) {
+            targetUrl = `http://${targetUrl}`;
+        }
         const isLocal = (0, server_probe_1.isLocalhost)(targetUrl);
         console.log("");
         console.log(theme_1.theme.brand.bold("🛠️  KramScan Dev Mode"));

package/dist/commands/gate.js

@@ -15,6 +15,9 @@ function registerGateCommand(program) {
         .option("--timeout <ms>", "Maximum scan duration", "60000")
         .option("--json", "Output results as JSON")
         .action(async (url, options) => {
+        if (!/^https?:\/\//i.test(url)) {
+            url = `http://${url}`;
+        }
         const jsonMode = options.json === true;
         if (!jsonMode) {
             console.log("");

package/dist/commands/onboard.js

@@ -140,8 +140,8 @@ function registerOnboardCommand(program) {
                 type: "list",
                 name: "reportFormat",
                 message: "Default report format",
-                choices: ["word", "txt", "json"],
-                default: config.report.defaultFormat,
+                choices: ["markdown", "word", "txt", "json"],
+                default: config.report.defaultFormat || "markdown",
             },
             {
                 type: "confirm",

package/dist/commands/report.js

@@ -8,6 +8,8 @@ const chalk_1 = __importDefault(require("chalk"));
 const docx_1 = require("docx");
 const promises_1 = __importDefault(require("fs/promises"));
 const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const inquirer_1 = __importDefault(require("inquirer"));
 const config_1 = require("../core/config");
 const scan_storage_1 = require("../core/scan-storage");
 const ai_client_1 = require("../core/ai-client");
@@ -16,7 +18,7 @@ function registerReportCommand(program) {
     program
         .command("report [scan-file]")
         .description("Generate a professional security report")
-        .option("-f, --format <type>", "Report format: word|json|txt")
+        .option("-f, --format <type>", "Report format: word|json|txt|markdown")
         .option("-o, --output <file>", "Output filename")
         .option("--ai-summary", "Generate an AI-powered executive summary")
         .action(async (scanFile, options) => {
@@ -34,7 +36,10 @@ function registerReportCommand(program) {
             const content = await promises_1.default.readFile(filepath, "utf-8");
             const scanResult = JSON.parse(content);
             const config = await (0, config_1.getConfig)();
-            const format = (options.format || config.report.defaultFormat);
+            let format = (options.format || config.report.defaultFormat);
+            if (!options.format && !config.report.defaultFormat) {
+                format = "markdown";
+            }
             let aiSummary;
             if (options.aiSummary) {
                 spinner = logger_1.logger.spinner("Generating AI executive summary...");
@@ -47,17 +52,42 @@ function registerReportCommand(program) {
                     spinner.warn(`AI summary failed: ${err.message}`);
                 }
             }
+            let outputDir = "";
+            if (!options.output) {
+                const { location } = await inquirer_1.default.prompt([
+                    {
+                        type: "list",
+                        name: "location",
+                        message: "Where should the report be saved?",
+                        choices: [
+                            { name: "Current Project Directory (./)", value: "cwd" },
+                            { name: "Desktop", value: "desktop" },
+                            { name: "Default Reports Directory (~/.kramscan/reports/)", value: "default" }
+                        ]
+                    }
+                ]);
+                if (location === "cwd") {
+                    outputDir = process.cwd();
+                }
+                else if (location === "desktop") {
+                    outputDir = path_1.default.join(os_1.default.homedir(), "Desktop");
+                }
+            }
             spinner = logger_1.logger.spinner(`Generating ${format.toUpperCase()} report...`);
             let outputPath;
             switch (format) {
                 case "word":
-                    outputPath = await generateWordReport(scanResult, options.output, aiSummary);
+                    outputPath = await generateWordReport(scanResult, options.output, aiSummary, outputDir);
                     break;
                 case "json":
-                    outputPath = await generateJsonReport(scanResult, options.output, aiSummary);
+                    outputPath = await generateJsonReport(scanResult, options.output, aiSummary, outputDir);
                     break;
                 case "txt":
-                    outputPath = await generateTxtReport(scanResult, options.output, aiSummary);
+                    outputPath = await generateTxtReport(scanResult, options.output, aiSummary, outputDir);
+                    break;
+                case "markdown":
+                case "md":
+                    outputPath = await generateMarkdownReport(scanResult, options.output, aiSummary, outputDir);
                     break;
                 default:
                     throw new Error(`Unsupported format: ${format}`);
@@ -76,7 +106,7 @@ function registerReportCommand(program) {
         }
     });
 }
-async function generateWordReport(scanResult, outputFile, aiSummary) {
+async function generateWordReport(scanResult, outputFile, aiSummary, outputDir) {
     const doc = new docx_1.Document({
         sections: [
             {
@@ -145,15 +175,15 @@ async function generateWordReport(scanResult, outputFile, aiSummary) {
         ],
     });
     const buffer = await docx_1.Packer.toBuffer(doc);
-    const reportsDir = await (0, scan_storage_1.ensureReportsDirectory)();
+    const reportsDir = outputDir || await (0, scan_storage_1.ensureReportsDirectory)();
     const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
     const filename = outputFile || `report-${timestamp}.docx`;
     const filepath = path_1.default.isAbsolute(filename) ? filename : path_1.default.join(reportsDir, filename);
     await promises_1.default.writeFile(filepath, buffer);
     return filepath;
 }
-async function generateJsonReport(scanResult, outputFile, aiSummary) {
-    const reportsDir = await (0, scan_storage_1.ensureReportsDirectory)();
+async function generateJsonReport(scanResult, outputFile, aiSummary, outputDir) {
+    const reportsDir = outputDir || await (0, scan_storage_1.ensureReportsDirectory)();
     const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
     const filename = outputFile || `report-${timestamp}.json`;
     const filepath = path_1.default.isAbsolute(filename) ? filename : path_1.default.join(reportsDir, filename);
@@ -161,7 +191,7 @@ async function generateJsonReport(scanResult, outputFile, aiSummary) {
     await promises_1.default.writeFile(filepath, JSON.stringify(finalResult, null, 2));
     return filepath;
 }
-async function generateTxtReport(scanResult, outputFile, aiSummary) {
+async function generateTxtReport(scanResult, outputFile, aiSummary, outputDir) {
     const lines = [];
     lines.push("=".repeat(60));
     lines.push("SECURITY ASSESSMENT REPORT");
@@ -208,10 +238,58 @@ async function generateTxtReport(scanResult, outputFile, aiSummary) {
     lines.push("=".repeat(60));
     lines.push("End of Report");
     lines.push("=".repeat(60));
-    const reportsDir = await (0, scan_storage_1.ensureReportsDirectory)();
+    const reportsDir = outputDir || await (0, scan_storage_1.ensureReportsDirectory)();
     const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
     const filename = outputFile || `report-${timestamp}.txt`;
     const filepath = path_1.default.isAbsolute(filename) ? filename : path_1.default.join(reportsDir, filename);
     await promises_1.default.writeFile(filepath, lines.join("\n"));
     return filepath;
 }
+async function generateMarkdownReport(scanResult, outputFile, aiSummary, outputDir) {
+    const lines = [];
+    lines.push("# Security Assessment Report");
+    lines.push("");
+    lines.push(`**Target:** \`${scanResult.target}\``);
+    lines.push(`**Date:** ${new Date(scanResult.timestamp).toLocaleString()}`);
+    lines.push(`**Duration:** ${(scanResult.duration / 1000).toFixed(2)}s`);
+    lines.push("");
+    lines.push("## Executive Summary");
+    if (aiSummary) {
+        lines.push(aiSummary);
+    }
+    else {
+        lines.push(`Total Vulnerabilities: **${scanResult.summary.total}** (${scanResult.summary.critical} Critical, ${scanResult.summary.high} High, ${scanResult.summary.medium} Medium, ${scanResult.summary.low} Low, ${scanResult.summary.info} Info)`);
+    }
+    lines.push("");
+    lines.push("## Scan Statistics");
+    lines.push(`- **URLs Crawled:** ${scanResult.metadata.crawledUrls}`);
+    lines.push(`- **Forms Tested:** ${scanResult.metadata.testedForms}`);
+    lines.push(`- **Requests Made:** ${scanResult.metadata.requestsMade}`);
+    lines.push("");
+    lines.push("## Detailed Findings");
+    lines.push("");
+    scanResult.vulnerabilities.forEach((vuln, index) => {
+        lines.push(`### ${index + 1}. ${vuln.title} [${vuln.severity.toUpperCase()}]`);
+        lines.push(`- **URL:** \`${vuln.url}\``);
+        lines.push(`- **Type:** ${vuln.type}`);
+        lines.push(`- **Description:** ${vuln.description}`);
+        if (vuln.evidence) {
+            lines.push(`- **Evidence:** \`${vuln.evidence}\``);
+        }
+        if (vuln.remediation) {
+            lines.push(`- **Remediation:** ${vuln.remediation}`);
+        }
+        if (vuln.cwe) {
+            lines.push(`- **CWE:** ${vuln.cwe}`);
+        }
+        lines.push("");
+    });
+    lines.push("---");
+    lines.push("*Generated by KramScan*");
+    const reportsDir = outputDir || await (0, scan_storage_1.ensureReportsDirectory)();
+    const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
+    const filename = outputFile || `report-${timestamp}.md`;
+    const filepath = path_1.default.isAbsolute(filename) ? filename : path_1.default.join(reportsDir, filename);
+    await promises_1.default.writeFile(filepath, lines.join("\n"));
+    return filepath;
+}

package/dist/commands/scan.js

@@ -71,6 +71,9 @@ function registerScanCommand(program) {
             console.log(theme_1.theme.gray("─".repeat(50)));
             console.log("");
         }
+        if (!/^https?:\/\//i.test(url)) {
+            url = `http://${url}`;
+        }
         // Validate URL
         try {
             new URL(url);
@@ -273,6 +276,7 @@ function registerScanCommand(program) {
                         choices: [
                             { name: "🧠  Analyze findings with AI", value: "analyze" },
                             { name: "📄  Generate a professional report", value: "report" },
+                            { name: "🤖  Generate AI-ready Markdown report for fixing issues", value: "markdown" },
                             { name: "👋  Exit to main menu", value: "exit" }
                         ]
                     }
@@ -289,6 +293,12 @@ function registerScanCommand(program) {
                     registerReportCommand(reportProgram);
                     await reportProgram.parseAsync(["node", "kramscan", "report", filepath]);
                 }
+                else if (nextAction === "markdown") {
+                    const { registerReportCommand } = await Promise.resolve().then(() => __importStar(require("./report")));
+                    const reportProgram = new commander_1.Command();
+                    registerReportCommand(reportProgram);
+                    await reportProgram.parseAsync(["node", "kramscan", "report", filepath, "-f", "markdown"]);
+                }
             }
         }
         catch (error) {

package/dist/index.js

@@ -1,9 +1,23 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_1 = require("./cli");
 const errors_1 = require("./core/errors");
+const update_notifier_1 = __importDefault(require("update-notifier"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 // Ensure uncaught exceptions and unhandled rejections produce useful output
 (0, errors_1.setupGlobalErrorHandlers)();
+try {
+    const pkgPath = path_1.default.join(__dirname, "../package.json");
+    const pkg = JSON.parse(fs_1.default.readFileSync(pkgPath, "utf-8"));
+    (0, update_notifier_1.default)({ pkg }).notify({ isGlobal: true });
+}
+catch (error) {
+    // Silently ignore if update notification fails
+}
 (0, cli_1.run)().catch((err) => {
     console.error("Fatal error:", err);
     process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kramscan",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "KramScan CLI — AI-powered web app security testing",
   "author": "Akram Shaikh (https://akramshaikh.me)",
   "license": "MIT",
@@ -54,6 +54,7 @@
     "@anthropic-ai/sdk": "^0.31.0",
     "@google/generative-ai": "^0.24.1",
     "@mistralai/mistralai": "^1.14.0",
+    "@types/update-notifier": "^5.1.0",
     "axios": "^1.6.8",
     "chalk": "^5.6.2",
     "commander": "^12.1.0",
@@ -65,6 +66,7 @@
     "openai": "^4.104.0",
     "ora": "^8.2.0",
     "puppeteer": "^22.15.0",
+    "update-notifier": "^5.1.0",
     "uuid": "^9.0.1"
   },
   "devDependencies": {