@kamrankhan027/probe-ai 1.0.2 → 1.0.4

package/README.md

@@ -0,0 +1,128 @@
+# 🔍 ProbeAI — Autonomous API Reliability & Postman Suite Generator
+
+<div align="center">
+
+**An autonomous developer CLI agent that inspects OpenAPI specs, synthesizes multi-scenario test suites, executes real-time HTTP calls, and auto-exports ready-to-import Postman collections.**
+
+[![npm version](https://img.shields.io/npm/v/@kamrankhan027/probe-ai.svg?style=for-the-badge&color=CB3837&logo=npm)](https://www.npmjs.com/package/@kamrankhan027/probe-ai)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
+[![LangGraph](https://img.shields.io/badge/LangGraph.js-1C3C3C?style=for-the-badge&logo=langchain&logoColor=white)](https://langchain-ai.github.io/langgraphjs/)
+[![Gemini](https://img.shields.io/badge/Gemini_3.6_Flash-8E75B2?style=for-the-badge&logo=google&logoColor=white)](https://ai.google.dev/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+
+</div>
+
+---
+
+## ⚡ Quickstart
+
+### Option 1: Run Instantly via `npx` (Zero Installation Required)
+```bash
+npx @kamrankhan027/probe-ai
+```
+
+---
+
+### Option 2: Install Globally
+
+**Using npm:**
+```bash
+npm install -g @kamrankhan027/probe-ai
+```
+
+**Using pnpm:**
+```bash
+pnpm add -g @kamrankhan027/probe-ai
+```
+
+**Using yarn:**
+```bash
+yarn global add @kamrankhan027/probe-ai
+```
+
+Then run ProbeAI from **any directory** on your machine:
+```bash
+probe-ai
+```
+
+---
+
+## 🔑 API Key Setup
+
+ProbeAI uses Google Gemini for fast, structured reasoning. 
+* **If you have a `.env` file**: Add `GEMINI_API_KEY=your_key_here`
+* **If running via `npx` without a `.env`**: ProbeAI will interactively prompt you to paste your free Gemini API key on startup.
+
+*(Get a free key in 10 seconds at [aistudio.google.com](https://aistudio.google.com/)).*
+
+---
+
+## 🌟 Key Superpowers
+
+* **🔍 Auto-Discovery via OpenAPI**: Probes any API base URL (e.g. `http://localhost:8000`) and parses `/openapi.json` to map all routes, parameters, and security schemas.
+* **📦 1-Click Postman Collection Export**: Eliminates 30+ minutes of manual route recreation by generating ready-to-import **Postman Collection v2.1** files (`reports/probe_collection.json`).
+* **🔐 Smart Auth Detective**: Supports direct token injection (`Bearer ...` or `X-API-Key`) **AND** autonomous login flows (executing `POST /auth/login`, extracting the JWT token, and binding it to subsequent requests).
+* **⚡ Real-Time HTTP Latency Profiling**: Fires live requests, catches `422/404/401` edge cases, and logs latency in milliseconds.
+* **📊 Standalone HTML & Terminal Reports**: Generates interactive single-page HTML audit dashboards with health scores and payload replays.
+
+---
+
+## 💡 Example Prompts to Try
+
+```text
+You: Inspect https://bookmark-agent-backend.onrender.com and export a Postman collection
+```
+*Auto-maps all endpoints and creates `reports/postman_collection.json`.*
+
+```text
+You: Test all endpoints on https://bookmark-agent-backend.onrender.com and save an HTML report
+```
+*Executes Happy Path, Query Filter, and Error test cases and saves `reports/audit_report.html`.*
+
+```text
+You: Set auth Bearer my_jwt_token_123 and test protected endpoints
+```
+*Injects your authorization header into session memory for all subsequent calls.*
+
+```text
+You: Authenticate via POST https://api.example.com/login with {"email":"dev@example.com","password":"secret"}, then test /api/dashboard
+```
+*Extracts the JWT from the login response and tests the protected dashboard route automatically.*
+
+---
+
+## 🏗️ Repository Architecture
+
+```text
+probe-ai/
+├── cli/                            # 🚀 Native TypeScript NPM Package (@kamrankhan027/probe-ai)
+│   ├── src/
+│   │   ├── index.ts                # Interactive CLI loop & Marked terminal styling
+│   │   ├── agent.ts                # @langchain/langgraph ReAct workflow
+│   │   └── tools/                  # OpenAPI, HTTP, Auth, Postman & Report tools
+│   ├── dist/
+│   │   └── index.js                # ⚡ Single zero-dependency bundled executable (tsup)
+│   └── package.json
+├── python/                         # Python implementation (LangGraph + Rich)
+│   ├── agent.py
+│   └── requirements.txt
+└── reports/                        # Shared output directory
+```
+
+---
+
+## 🛠️ Local Development
+
+```bash
+git clone https://github.com/kamran-027/probe-ai.git
+cd probe-ai/cli
+npm install
+npm run build
+npm start
+```
+
+---
+
+<div align="center">
+Built by <b>Kamran Khan</b> as part of <b>Cadence Labs</b>.
+</div>

package/dist/index.js

@@ -7,8 +7,7 @@ var __export = (target, all) => {
 
 // src/index.ts
 import dotenv from "dotenv";
-import chalk6 from "chalk";
-import boxen from "boxen";
+import chalk7 from "chalk";
 import ora from "ora";
 import readline from "readline";
 import { marked } from "marked";
@@ -4067,15 +4066,81 @@ var NEVER = INVALID;
 
 // src/tools/openapi.ts
 import axios from "axios";
+import chalk2 from "chalk";
+
+// src/ui.ts
 import chalk from "chalk";
+import boxen from "boxen";
+function printModernBanner(version = "1.0.4") {
+  const content = `${chalk.bold.hex("#6366F1")("\u2726 PROBE AI")}  ${chalk.dim(`v${version}`)}  ${chalk.hex("#10B981")("\u25CF READY")}
+${chalk.white("Autonomous API Schema & Reliability Inspector")}
+
+${chalk.dim("Capabilities:")}
+  ${chalk.cyan("\u2022")} ${chalk.bold("OpenAPI Discovery")}  ${chalk.dim("Auto-maps schemas & security")}
+  ${chalk.cyan("\u2022")} ${chalk.bold("Postman Exporter")}   ${chalk.dim("1-click collection generation")}
+  ${chalk.cyan("\u2022")} ${chalk.bold("Smart Auth")}         ${chalk.dim("Login token exchange & Bearer injection")}
+  ${chalk.cyan("\u2022")} ${chalk.bold("HTML Audit Reports")} ${chalk.dim("Latency profiling & payload replays")}
+
+${chalk.dim("Quick Test Prompts:")}
+  ${chalk.gray("\u276F")} ${chalk.yellow("Inspect https://bookmark-agent-backend.onrender.com and export Postman collection")}
+  ${chalk.gray("\u276F")} ${chalk.yellow("Test all endpoints on http://localhost:8000 and save HTML report")}
+  ${chalk.dim("Type 'exit' to quit")}`;
+  console.log(
+    boxen(content, {
+      padding: { top: 1, bottom: 1, left: 2, right: 2 },
+      margin: { top: 1, bottom: 1 },
+      borderStyle: "round",
+      borderColor: "#6366F1"
+    })
+  );
+}
+function formatMethodBadge(method) {
+  const m = method.toUpperCase();
+  switch (m) {
+    case "GET":
+      return chalk.bgBlue.bold.white(" GET ");
+    case "POST":
+      return chalk.bgGreen.bold.white(" POST ");
+    case "PUT":
+      return chalk.bgYellow.bold.black(" PUT ");
+    case "DELETE":
+      return chalk.bgRed.bold.white(" DEL ");
+    case "PATCH":
+      return chalk.bgMagenta.bold.white(" PATCH ");
+    default:
+      return chalk.bgGray.bold.white(` ${m} `);
+  }
+}
+function formatStatusBadge(status) {
+  if (status >= 200 && status < 300) {
+    return chalk.hex("#10B981").bold(`${status} OK`);
+  }
+  if (status === 401 || status === 403) {
+    return chalk.hex("#F59E0B").bold(`${status} Auth Required`);
+  }
+  if (status === 404) {
+    return chalk.hex("#64748B").bold(`${status} Not Found`);
+  }
+  if (status === 422) {
+    return chalk.hex("#EC4899").bold(`${status} Unprocessable Entity`);
+  }
+  return chalk.hex("#EF4444").bold(`${status} Error`);
+}
+function logStep(icon, title, detail = "") {
+  const iconColored = chalk.hex("#6366F1")(icon);
+  const titleColored = chalk.bold.white(title);
+  const detailColored = detail ? chalk.dim(` ${detail}`) : "";
+  console.log(`  ${iconColored}  ${titleColored}${detailColored}`);
+}
+
+// src/tools/openapi.ts
 var fetchOpenApiSpecTool = tool(
   async ({ baseUrl }) => {
-    console.log(chalk.cyan(`
-\u{1F50D} [Tool: fetch_openapi_spec] Probing: ${baseUrl}`));
     let targetUrl = baseUrl.replace(/\/+$/, "");
     if (!targetUrl.endsWith("openapi.json")) {
       targetUrl = `${targetUrl}/openapi.json`;
     }
+    logStep("\u{1F50D}", "Probing OpenAPI Spec", chalk2.cyan(targetUrl));
     try {
       const response = await axios.get(targetUrl, { timeout: 1e4 });
       const spec = response.data;
@@ -4096,6 +4161,7 @@ var fetchOpenApiSpecTool = tool(
           });
         }
       }
+      logStep("\u2713", `Discovered ${endpointsSummary.length} endpoints`, chalk2.dim(`(API v${info.version || "1.0"})`));
       return JSON.stringify(
         {
           title: info.title || "API Spec",
@@ -4108,6 +4174,7 @@ var fetchOpenApiSpecTool = tool(
         2
       );
     } catch (err) {
+      logStep("\u2715", "Could not fetch OpenAPI spec", chalk2.red(err.message));
       return `Could not fetch OpenAPI spec from ${targetUrl}: ${err.message}`;
     }
   },
@@ -4123,7 +4190,7 @@ var fetchOpenApiSpecTool = tool(
 // src/tools/auth.ts
 import { tool as tool2 } from "@langchain/core/tools";
 import axios2 from "axios";
-import chalk2 from "chalk";
+import chalk3 from "chalk";
 
 // src/tools/state.ts
 var sessionHeaders = {
@@ -4139,8 +4206,7 @@ var authenticateViaLoginTool = tool2(
     payloadJson = "{}",
     tokenField = "access_token"
   }) => {
-    console.log(chalk2.green(`
-\u{1F510} [Tool: authenticate_via_login] Authenticating at: ${loginUrl}`));
+    logStep("\u{1F510}", "Authenticating via login endpoint...", chalk3.dim(loginUrl));
     let payload = {};
     try {
       if (payloadJson && payloadJson.trim() !== "{}") {
@@ -4162,12 +4228,14 @@ var authenticateViaLoginTool = tool2(
         token = data[tokenField] || data.token || data.access_token || data.jwt || data.key;
       }
       if (!token) {
+        logStep("\u2715", "Login succeeded but token field not found", chalk3.red(tokenField));
         return `Login succeeded (HTTP ${res.status}), but token field '${tokenField}' was not found in response: ${JSON.stringify(data)}`;
       }
       sessionHeaders["Authorization"] = `Bearer ${token}`;
-      console.log(chalk2.green(`  \u2514\u2500 Success! Extracted token and bound 'Authorization: Bearer ...' to session.`));
+      logStep("\u2713", "Extracted Bearer token & saved to session", chalk3.hex("#10B981")("Authorization: Bearer \u2022\u2022\u2022\u2022\u2022\u2022"));
       return `Authentication successful. Bearer token extracted from '${tokenField}' and saved to session headers.`;
     } catch (err) {
+      logStep("\u2715", "Login failed", chalk3.red(err.message));
       return `Login request failed: ${err.message}`;
     }
   },
@@ -4189,8 +4257,7 @@ var setAuthHeaderTool = tool2(
       cleanVal = `Bearer ${cleanVal}`;
     }
     sessionHeaders[headerName] = cleanVal;
-    console.log(chalk2.green(`
-\u{1F511} [Tool: set_auth_header] Set '${headerName}' header in session.`));
+    logStep("\u{1F511}", `Set auth header: ${headerName}`, chalk3.hex("#10B981")("\u2022\u2022\u2022\u2022\u2022\u2022"));
     return `Successfully set '${headerName}' header in session.`;
   },
   {
@@ -4206,7 +4273,7 @@ var setAuthHeaderTool = tool2(
 // src/tools/http.ts
 import { tool as tool3 } from "@langchain/core/tools";
 import axios3 from "axios";
-import chalk3 from "chalk";
+import chalk4 from "chalk";
 var executeHttpRequestTool = tool3(
   async ({
     method,
@@ -4216,8 +4283,6 @@ var executeHttpRequestTool = tool3(
     bodyJson = "{}"
   }) => {
     const cleanMethod = method.trim().toUpperCase();
-    console.log(chalk3.yellow(`
-\u26A1 [Tool: execute_http_request] ${cleanMethod} ${url}`));
     const mergedHeaders = { ...sessionHeaders };
     try {
       if (headersJson && headersJson.trim() !== "{}") {
@@ -4247,12 +4312,20 @@ var executeHttpRequestTool = tool3(
         params,
         data,
         validateStatus: () => true,
-        // Don't throw on 4xx/5xx so agent can inspect response
         timeout: 15e3
       });
       const elapsedMs = Date.now() - startTime;
-      const statusColor = response.status >= 200 && response.status < 300 ? chalk3.green : chalk3.red;
-      console.log(`  \u2514\u2500 Status: ${statusColor(response.status)} | Latency: ${chalk3.cyan(`${elapsedMs}ms`)}`);
+      const methodBadge = formatMethodBadge(cleanMethod);
+      const statusBadge = formatStatusBadge(response.status);
+      const latencyStr = chalk4.dim(`${elapsedMs}ms`);
+      let pathPreview = url;
+      try {
+        const u = new URL(url);
+        pathPreview = u.pathname + (u.search || "");
+      } catch {
+        pathPreview = url;
+      }
+      console.log(`  \u26A1 ${methodBadge} ${chalk4.white(pathPreview)}  ${statusBadge}  ${latencyStr}`);
       const now = /* @__PURE__ */ new Date();
       testExecutionLogs.push({
         method: cleanMethod,
@@ -4277,6 +4350,7 @@ var executeHttpRequestTool = tool3(
         2
       );
     } catch (err) {
+      console.log(`  \u2715 ${chalk4.bgRed.white(` ${cleanMethod} `)} ${chalk4.red(url)}  ${chalk4.red(err.message)}`);
       return JSON.stringify({
         error: `Request failed: ${err.message}`,
         status_code: 0
@@ -4299,7 +4373,7 @@ var executeHttpRequestTool = tool3(
 // src/tools/postman.ts
 import { tool as tool4 } from "@langchain/core/tools";
 import axios4 from "axios";
-import chalk4 from "chalk";
+import chalk5 from "chalk";
 import fs from "fs";
 import path from "path";
 var exportPostmanCollectionTool = tool4(
@@ -4307,12 +4381,11 @@ var exportPostmanCollectionTool = tool4(
     baseUrl,
     outputFilename = "probe_collection.json"
   }) => {
-    console.log(chalk4.magenta(`
-\u{1F4E6} [Tool: export_postman_collection] Exporting Postman collection...`));
     let targetUrl = baseUrl.replace(/\/+$/, "");
     if (!targetUrl.endsWith("openapi.json")) {
       targetUrl = `${targetUrl}/openapi.json`;
     }
+    logStep("\u{1F4E6}", "Generating Postman v2.1 Collection...", chalk5.dim(baseUrl));
     try {
       const res = await axios4.get(targetUrl, { timeout: 1e4 });
       const spec = res.data;
@@ -4359,9 +4432,10 @@ var exportPostmanCollectionTool = tool4(
       }
       const outPath = path.join(reportsDir, path.basename(outputFilename));
       fs.writeFileSync(outPath, JSON.stringify(postmanCollection, null, 2));
-      console.log(chalk4.green(`  \u2514\u2500 Saved Postman Collection to: ${outPath}`));
+      logStep("\u2713", `Saved Postman Collection (${postmanItems.length} routes)`, chalk5.hex("#10B981")(outPath));
       return `Postman collection with ${postmanItems.length} endpoints successfully generated at '${outPath}'. You can import this directly into Postman/Bruno/Insomnia!`;
     } catch (err) {
+      logStep("\u2715", "Postman Export Failed", chalk5.red(err.message));
       return `Failed to export Postman collection: ${err.message}`;
     }
   },
@@ -4377,7 +4451,7 @@ var exportPostmanCollectionTool = tool4(
 
 // src/tools/report.ts
 import { tool as tool5 } from "@langchain/core/tools";
-import chalk5 from "chalk";
+import chalk6 from "chalk";
 import fs2 from "fs";
 import path2 from "path";
 var saveHtmlAuditReportTool = tool5(
@@ -4478,8 +4552,7 @@ var saveHtmlAuditReportTool = tool5(
 </html>
 `;
     fs2.writeFileSync(outPath, htmlContent);
-    console.log(chalk5.green(`
-\u{1F4CA} [Tool: save_html_audit_report] Interactive HTML Report saved to: ${outPath}`));
+    logStep("\u{1F4CA}", "Generated HTML Audit Dashboard", chalk6.hex("#10B981")(outPath));
     return `HTML audit report successfully generated at '${outPath}'. Open it in your browser to view the interactive dashboard!`;
   },
   {
@@ -4512,7 +4585,9 @@ function createProbeAgent(apiKey) {
   const model = new ChatGoogleGenerativeAI({
     model: "gemini-3.6-flash",
     temperature: 0.2,
-    apiKey
+    apiKey,
+    maxRetries: 3
+    // Auto-retry on transient Google 503 spikes
   }).bindTools(tools);
   const callModel = async (state) => {
     const response = await model.invoke(state.messages);
@@ -4539,9 +4614,10 @@ marked.use(
     width: 90,
     reflowText: true,
     tab: 2,
-    heading: chalk6.bold.cyan,
-    firstHeading: chalk6.bold.magenta,
-    strong: chalk6.bold.white,
+    heading: chalk7.bold.hex("#6366F1"),
+    firstHeading: chalk7.bold.hex("#A855F7"),
+    strong: chalk7.bold.white,
+    listitem: chalk7.cyan,
     tableOptions: {
       style: {
         head: ["cyan", "bold"],
@@ -4550,28 +4626,8 @@ marked.use(
     }
   })
 );
-function printBanner() {
-  console.log(
-    boxen(
-      `${chalk6.bold.cyan("\u{1F50D} ProbeAI \u2014 Autonomous API Reliability & Postman Suite Generator")}
-${chalk6.dim("TypeScript CLI Edition \u2022 Dynamic Auth \u2022 Postman v2.1 Exporter \u2022 HTML Reports")}
-
-${chalk6.yellow("Try prompts like:")}
- \u2022 'Inspect https://bookmark-agent-backend.onrender.com and export a Postman collection'
- \u2022 'Test all endpoints on https://bookmark-agent-backend.onrender.com and save an HTML report'
- \u2022 'Set auth Bearer my_secret_token and test protected routes'
- \u2022 Type ${chalk6.bold.red("'exit'")} to quit`,
-      {
-        padding: 1,
-        margin: 1,
-        borderStyle: "round",
-        borderColor: "cyan"
-      }
-    )
-  );
-}
 async function main() {
-  printBanner();
+  printModernBanner("1.0.4");
   const rl = readline.createInterface({
     input: process.stdin,
     output: process.stdout
@@ -4585,30 +4641,33 @@ async function main() {
   };
   let apiKey = process.env.GEMINI_API_KEY || process.env.GOOGLE_API_KEY;
   if (!apiKey) {
-    console.log(chalk6.yellow("\u{1F511} No GEMINI_API_KEY found in your environment or .env file."));
-    console.log(chalk6.dim("Get a free key from https://aistudio.google.com/\n"));
-    apiKey = await promptUser(chalk6.bold.cyan("Enter your Gemini API Key: "));
+    console.log(chalk7.yellow("\u{1F511} No GEMINI_API_KEY found in your environment or .env file."));
+    console.log(chalk7.dim("Get a free key from https://aistudio.google.com/\n"));
+    apiKey = await promptUser(chalk7.bold.hex("#6366F1")("Enter your Gemini API Key: "));
     if (!apiKey) {
-      console.log(chalk6.red("\nError: An API key is required to run ProbeAI. Exiting...\n"));
+      console.log(chalk7.red("\nError: An API key is required to run ProbeAI. Exiting...\n"));
       rl.close();
       process.exit(1);
     }
-    console.log(chalk6.green("\u2705 API Key registered for this session.\n"));
+    console.log(chalk7.hex("#10B981")("\u2713 API Key registered for this session.\n"));
   }
   const app = createProbeAgent(apiKey);
   const messages = [PROBE_SYSTEM_MESSAGE];
   while (true) {
     try {
-      const input = await promptUser(chalk6.bold.green("\nYou: "));
+      const promptSymbol = chalk7.bold.hex("#6366F1")("\u276F ");
+      const input = await promptUser(`
+${promptSymbol}`);
       if (!input) continue;
       if (input.toLowerCase() === "exit" || input.toLowerCase() === "quit") {
-        console.log(chalk6.cyan("\nGoodbye! \u{1F44B}\n"));
+        console.log(chalk7.hex("#6366F1")("\nGoodbye! \u{1F44B}\n"));
         rl.close();
         process.exit(0);
       }
+      console.log();
       messages.push(new HumanMessage(input));
       const spinner = ora({
-        text: chalk6.dim("ProbeAI thinking..."),
+        text: chalk7.dim("Synthesizing test scenarios & auditing schemas..."),
         color: "cyan"
       }).start();
       let finalResponse = "";
@@ -4623,12 +4682,16 @@ async function main() {
       }
       spinner.stop();
       if (finalResponse) {
-        console.log("\n" + chalk6.bold.cyan("\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 ProbeAI Assessment \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\n"));
+        console.log(
+          "\n" + chalk7.hex("#6366F1")(
+            "\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 ProbeAI Assessment \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\n"
+          )
+        );
         const rendered = marked(finalResponse);
         console.log(rendered);
       }
     } catch (err) {
-      console.log(chalk6.red(`
+      console.log(chalk7.red(`
 An error occurred: ${err.message}`));
     }
   }

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "@kamrankhan027/probe-ai",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Autonomous API Schema & Reliability Inspector CLI. Probes OpenAPI specs, generates test suites, executes real-time HTTP calls, and exports Postman collections.",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "bin": "dist/index.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "probe-ai": "./dist/index.js"
+  },
   "files": [
     "dist"
   ],
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "start": "node dist/index.js"
+    "start": "node ./dist/index.js"
   },
   "keywords": [
     "ai",