@vibecheckai/cli 3.2.6 → 3.4.0

package/bin/registry.js

@@ -1,37 +1,42 @@
 /**
- * Vibecheck CLI Command Registry (LOCKED)
+ * Vibecheck CLI Command Registry
  *
  * Single source of truth for the public CLI surface.
  * If it isn't here, it does not exist.
+ * 
+ * Simple 2-tier model:
+ * - FREE ($0): Inspect & Observe
+ * - PRO ($69/mo): Fix, Prove & Enforce
  */
 
 "use strict";
 
 // ─────────────────────────────────────────────────────────────
-// CORE 17 COMMANDS (locked surface area)
+// CLI COMMANDS (2-tier: FREE / PRO)
 // ─────────────────────────────────────────────────────────────
 const ALLOWED_COMMANDS = new Set([
-  // FREE (8) - Core functionality to try the product
+  // FREE (10) - Inspect & Observe
   "init",       // one-time setup
   "doctor",     // health check
   "watch",      // continuous mode
-  "scan",       // includes --allowlist subcommand
-  "ship",       // verdict engine
+  "scan",       // static analysis
+  "report",     // generate reports
+  "context",    // generate IDE rules
+  "classify",   // Authority: inventory (read-only)
   "login",      // authenticate
   "logout",     // remove credentials
   "whoami",     // show current user
 
-  // STARTER (6) - Productivity & automation
+  // PRO (9) - Fix, Prove & Enforce
+  "ship",       // verdict engine (GO/NO-GO)
   "fix",        // AI-powered fixes
-  "report",     // generate reports
-  "context",    // generate IDE rules
-  "guard",      // AI guardrails (prompt firewall, hallucination checking)
+  "prove",      // runtime proof
+  "reality",    // browser verification
+  "gate",       // CI/CD enforcement
+  "guard",      // AI guardrails
   "mcp",        // MCP server
-  "checkpoint", // baseline comparison & hallucination scoring
-
-  // PRO (3) - Advanced proof & AI testing
-  "prove",      // includes --bundle for evidence packs
-  "reality",    // includes --agent for AI testing
+  "checkpoint", // baseline comparison
+  "approve",    // Authority: verdicts
   "polish",     // production polish
 ]);
 
@@ -43,63 +48,128 @@ function assertAllowedOnly(obj) {
 }
 
 // ─────────────────────────────────────────────────────────────
-// COMMANDS (ALLOWED ONLY)
+// COMMANDS - 2-Tier: FREE and PRO ($69/mo)
 // ─────────────────────────────────────────────────────────────
 const COMMANDS = {
   // ══════════════════════════════════════════════════════════════
-  // FREE TIER (8 commands) - Core functionality to try the product
+  // FREE TIER - Inspect & Observe
   // ══════════════════════════════════════════════════════════════
 
-  // ── SETUP ───────────────────────────────────────────────────
   init: {
     description: "One-time setup (config + contracts + scripts)",
+    longDescription: "Initialize vibecheck in your project. Creates configuration files, sets up IDE rules, and optionally connects to the dashboard.",
     tier: "free",
     category: "setup",
     aliases: ["setup", "configure"],
     runner: () => require("./runners/runInit").runInit,
+    examples: [
+      { command: "vibecheck init", description: "Interactive setup wizard" },
+      { command: "vibecheck init --local", description: "Quick local-only setup" },
+      { command: "vibecheck init --quick", description: "Non-interactive defaults" },
+    ],
+    related: ["doctor", "scan"],
   },
 
   doctor: {
     description: "Environment + dependency + config health check",
+    longDescription: "Comprehensive diagnostics for your development environment.",
     tier: "free",
     category: "setup",
     aliases: ["health", "diag"],
     runner: () => require("./runners/runDoctor").runDoctor,
+    examples: [
+      { command: "vibecheck doctor", description: "Run all health checks" },
+      { command: "vibecheck doctor --fix", description: "Auto-fix detected issues" },
+      { command: "vibecheck doctor --json", description: "Output as JSON" },
+    ],
+    related: ["init", "scan"],
   },
 
   watch: {
     description: "Continuous mode - re-runs on changes",
+    longDescription: "File watcher that automatically re-runs scans when your code changes.",
     tier: "free",
     category: "setup",
     aliases: ["w", "dev"],
     runner: () => require("./runners/runWatch").runWatch,
+    examples: [
+      { command: "vibecheck watch", description: "Start watching" },
+      { command: "vibecheck watch --path ./src", description: "Watch specific directory" },
+    ],
+    related: ["scan"],
   },
 
-  // ── CORE LOOP ───────────────────────────────────────────────
   scan: {
-    description: "Route integrity & code analysis; use --allowlist for false positive management",
+    description: "Static code analysis; use --allowlist for false positives",
+    longDescription: "Scan your codebase for route integrity issues, security vulnerabilities, and code quality problems.",
     tier: "free",
     category: "proof",
     aliases: ["s", "check"],
     runner: () => require("./runners/runScan").runScan,
+    examples: [
+      { command: "vibecheck scan", description: "Quick scan" },
+      { command: "vibecheck scan --profile full", description: "Full scan" },
+      { command: "vibecheck scan --allowlist list", description: "View suppressed findings" },
+    ],
+    related: ["ship", "fix", "report"],
   },
 
-  ship: {
-    description: "Verdict engine - SHIP / WARN / BLOCK",
+  report: {
+    description: "Generate HTML/MD/SARIF reports",
+    longDescription: "Create shareable reports from scan results.",
     tier: "free",
-    category: "proof",
-    aliases: ["verdict", "go"],
-    runner: () => require("./runners/runShip").runShip,
+    category: "output",
+    aliases: ["html", "artifact"],
+    runner: () => require("./runners/runReport").runReport,
+    examples: [
+      { command: "vibecheck report", description: "Generate HTML report" },
+      { command: "vibecheck report --format md", description: "Markdown report" },
+      { command: "vibecheck report --format sarif", description: "SARIF for GitHub" },
+    ],
+    related: ["scan"],
+  },
+
+  context: {
+    description: "Generate IDE rules (.cursorrules, MDC, Copilot)",
+    longDescription: "Generate project-aware AI coding rules for your IDE.",
+    tier: "free",
+    category: "truth",
+    aliases: ["rules", "ai-rules", "mdc", "ctx"],
+    runner: () => require("./runners/runContext").runContext,
+    examples: [
+      { command: "vibecheck context", description: "Generate all IDE rules" },
+      { command: "vibecheck context --format cursor", description: ".cursorrules only" },
+    ],
+    related: ["scan", "guard"],
+  },
+
+  classify: {
+    description: "Inventory authority - duplication & legacy code maps",
+    longDescription: "Read-only inventory of your codebase including duplication maps and legacy code detection.",
+    tier: "free",
+    category: "authority",
+    aliases: ["inventory", "audit"],
+    runner: () => require("./runners/runClassify").runClassify,
+    examples: [
+      { command: "vibecheck classify", description: "Quick inventory" },
+      { command: "vibecheck classify --json", description: "JSON output" },
+    ],
+    related: ["approve", "scan"],
   },
 
-  // ── ACCOUNT (skipAuth) ────────────────────────────────────
   login: {
     description: "Authenticate with API key",
+    longDescription: "Connect your CLI to the vibecheck API.",
     tier: "free",
     category: "account",
     aliases: ["auth", "signin"],
     runner: () => require("./runners/runAuth").runLogin,
     skipAuth: true,
+    examples: [
+      { command: "vibecheck login", description: "Interactive login" },
+      { command: "vibecheck login --key YOUR_API_KEY", description: "Login with key" },
+    ],
+    related: ["logout", "whoami"],
   },
 
   logout: {
@@ -109,6 +179,10 @@ const COMMANDS = {
     aliases: ["signout"],
     runner: () => require("./runners/runAuth").runLogout,
     skipAuth: true,
+    examples: [
+      { command: "vibecheck logout", description: "Clear credentials" },
+    ],
+    related: ["login", "whoami"],
   },
 
   whoami: {
@@ -118,138 +192,280 @@ const COMMANDS = {
     aliases: ["me", "user"],
     runner: () => require("./runners/runAuth").runWhoami,
     skipAuth: true,
+    examples: [
+      { command: "vibecheck whoami", description: "Show user info" },
+    ],
+    related: ["login", "logout"],
   },
 
   // ══════════════════════════════════════════════════════════════
-  // STARTER TIER (6 commands) - Productivity & automation
+  // PRO TIER ($69/mo) - Fix, Prove & Enforce
   // ══════════════════════════════════════════════════════════════
 
+  ship: {
+    description: "Verdict engine - SHIP / WARN / BLOCK",
+    longDescription: "The final word on whether your code is ready to ship. Combines all scan results and generates a clear verdict.",
+    tier: "pro",
+    category: "proof",
+    aliases: ["verdict", "go"],
+    runner: () => require("./runners/runShip").runShip,
+    examples: [
+      { command: "vibecheck ship", description: "Get shipping verdict" },
+      { command: "vibecheck ship --strict", description: "Fail on warnings" },
+      { command: "vibecheck ship --badge", description: "Generate status badge" },
+    ],
+    related: ["scan", "prove", "fix"],
+  },
+
   fix: {
     description: "AI-powered auto-fix for findings",
-    tier: "starter",
+    longDescription: "Generate AI prompts to fix detected issues. Use --apply to let AI make changes directly.",
+    tier: "pro",
     category: "proof",
     aliases: ["f", "repair"],
     runner: () => require("./runners/runFix").runFix,
+    examples: [
+      { command: "vibecheck fix", description: "Generate fix missions" },
+      { command: "vibecheck fix --apply", description: "Apply AI fixes" },
+      { command: "vibecheck fix --loop", description: "Fix loop until clean" },
+    ],
+    related: ["scan", "ship"],
   },
 
-  report: {
-    description: "Generate HTML/MD/SARIF reports",
-    tier: "starter",
-    category: "output",
-    aliases: ["html", "artifact"],
-    runner: () => require("./runners/runReport").runReport,
+  prove: {
+    description: "Full proof loop with runtime verification",
+    longDescription: "Complete verification cycle with runtime testing and evidence generation.",
+    tier: "pro",
+    category: "proof",
+    aliases: ["p", "verify"],
+    runner: () => require("./runners/runProve").runProve,
+    examples: [
+      { command: "vibecheck prove", description: "Run full proof loop" },
+      { command: "vibecheck prove --url http://localhost:3000", description: "With runtime testing" },
+      { command: "vibecheck prove --bundle", description: "Generate evidence pack" },
+    ],
+    related: ["ship", "reality"],
   },
 
-  context: {
-    description: "Generate IDE rules (.cursorrules, MDC, Windsurf, Copilot)",
-    tier: "starter",
-    category: "truth",
-    aliases: ["rules", "ai-rules", "mdc"],
-    runner: () => require("./runners/runContext").runContext,
+  reality: {
+    description: "Browser-based runtime verification",
+    longDescription: "Verify your app's runtime behavior with Playwright-powered browser testing.",
+    tier: "pro",
+    category: "proof",
+    aliases: ["browser", "e2e"],
+    runner: () => require("./runners/runReality").runReality,
+    examples: [
+      { command: "vibecheck reality --url http://localhost:3000", description: "Test localhost" },
+      { command: "vibecheck reality --auth email:pass", description: "With authentication" },
+      { command: "vibecheck reality --agent", description: "AI agent testing" },
+    ],
+    related: ["prove", "ship"],
+  },
+
+  gate: {
+    description: "CI/CD enforcement - fail builds on issues",
+    longDescription: "Enforce quality gates in your CI/CD pipeline.",
+    tier: "pro",
+    category: "automation",
+    aliases: ["ci", "enforce"],
+    runner: () => require("./runners/runGuard").runGate,
+    examples: [
+      { command: "vibecheck gate", description: "Run CI gate check" },
+      { command: "vibecheck gate --strict", description: "Strict mode" },
+    ],
+    related: ["ship", "scan"],
   },
 
   guard: {
     description: "AI guardrails - prompt firewall & hallucination checking",
-    tier: "starter",
+    longDescription: "Validate AI-generated code and prompts. Detects prompt injection and verifies claims.",
+    tier: "pro",
     category: "truth",
     aliases: ["ai-guard", "firewall", "validate"],
     runner: () => require("./runners/runGuard").runGuard,
+    examples: [
+      { command: "vibecheck guard", description: "Run all guardrail checks" },
+      { command: "vibecheck guard --claims", description: "Verify AI claims" },
+    ],
+    related: ["context", "fix"],
   },
 
   mcp: {
     description: "Start MCP server for AI IDEs",
-    tier: "starter",
+    longDescription: "Launch an MCP server for AI IDE integration.",
+    tier: "pro",
     category: "automation",
     aliases: [],
     runner: () => require("./runners/runMcp").runMcp,
+    examples: [
+      { command: "vibecheck mcp", description: "Start MCP server" },
+      { command: "vibecheck mcp --port 3099", description: "Custom port" },
+    ],
+    related: ["context"],
   },
 
   checkpoint: {
     description: "Compare baseline vs current, hallucination scoring",
-    tier: "starter",
+    longDescription: "Track changes between scan runs. Detects new issues, resolved issues, and regressions.",
+    tier: "pro",
     category: "analysis",
     aliases: ["cp", "compare", "diff"],
     runner: () => require("./runners/runCheckpoint").runCheckpoint,
+    examples: [
+      { command: "vibecheck checkpoint", description: "Compare against baseline" },
+      { command: "vibecheck checkpoint --set", description: "Save new baseline" },
+    ],
+    related: ["scan", "fix"],
   },
 
-  // ══════════════════════════════════════════════════════════════
-  // PRO TIER (3 commands) - Advanced proof & AI testing
-  // ══════════════════════════════════════════════════════════════
-
-  reality: {
-    description: "Runtime proof (browser crawl); use --agent for AI testing",
+  approve: {
+    description: "Authority verdicts - PROCEED/STOP/DEFER with proofs",
+    longDescription: "Execute authorities to get structured verdicts with proofs.",
     tier: "pro",
-    category: "proof",
-    caps: "--agent for AI autonomous testing",
-    aliases: ["r", "test", "e2e"],
-    runner: () => async (args, ctx) => {
-      const { runRuntime } = require("./runners/runRuntime");
-      // Check if --agent flag is present to route to agent subcommand
-      if (args.includes("--agent") || args.includes("-a")) {
-        const filteredArgs = args.filter(a => a !== "--agent" && a !== "-a");
-        return await runRuntime(["agent", ...filteredArgs], ctx);
-      }
-      return await runRuntime(["crawl", ...args], ctx);
-    },
-  },
-
-  prove: {
-    description: "One command reality proof - video + network evidence that your app works",
-    tier: "pro",
-    category: "proof",
-    aliases: ["p", "full", "all"],
-    caps: "video, trace, HAR recording; use --bundle for evidence pack",
-    runner: () => require("./runners/runProve").runProve,
+    category: "authority",
+    aliases: ["auth-verdict", "authority"],
+    runner: () => require("./runners/runApprove").runApprove,
+    examples: [
+      { command: "vibecheck approve safe-consolidation", description: "Run authority" },
+      { command: "vibecheck approve --list", description: "List authorities" },
+    ],
+    related: ["classify", "ship"],
   },
 
   polish: {
-    description: "Production polish analyzer - finds missing essentials",
+    description: "Production polish - final cleanup before deploy",
+    longDescription: "Final production readiness checks and cleanup.",
     tier: "pro",
-    category: "quality",
-    aliases: ["quality", "finalize", "ready"],
+    category: "proof",
+    aliases: ["prod", "final"],
     runner: () => require("./runners/runPolish").runPolish,
+    examples: [
+      { command: "vibecheck polish", description: "Run polish checks" },
+    ],
+    related: ["ship", "prove"],
   },
 };
 
+// Validate that only allowed commands are defined
 assertAllowedOnly(COMMANDS);
 
 // ─────────────────────────────────────────────────────────────
-// DERIVED MAPS
+// TIER HELPERS
 // ─────────────────────────────────────────────────────────────
+function isPro(tier) {
+  return tier === "pro";
+}
+
+function requiresPro(commandName) {
+  const cmd = COMMANDS[commandName];
+  return cmd && cmd.tier === "pro";
+}
+
+function getFreeCommands() {
+  return Object.entries(COMMANDS)
+    .filter(([, cmd]) => cmd.tier === "free")
+    .map(([name]) => name);
+}
+
+function getProCommands() {
+  return Object.entries(COMMANDS)
+    .filter(([, cmd]) => cmd.tier === "pro")
+    .map(([name]) => name);
+}
+
+// ─────────────────────────────────────────────────────────────
+// BUILD DERIVED DATA STRUCTURES
+// ─────────────────────────────────────────────────────────────
+
+// Build alias map: { alias -> command }
 const ALIAS_MAP = {};
-for (const [cmd, def] of Object.entries(COMMANDS)) {
-  for (const alias of def.aliases || []) ALIAS_MAP[alias] = cmd;
+for (const [cmdName, cmd] of Object.entries(COMMANDS)) {
+  if (cmd.aliases) {
+    for (const alias of cmd.aliases) {
+      ALIAS_MAP[alias] = cmdName;
+    }
+  }
 }
 
-const ALL_COMMANDS = [
+// All command names including aliases
+const ALL_COMMANDS = new Set([
   ...Object.keys(COMMANDS),
-  ...Object.values(COMMANDS).flatMap((c) => c.aliases || []),
-];
+  ...Object.keys(ALIAS_MAP),
+]);
 
 // ─────────────────────────────────────────────────────────────
-// RUNNER LOADER
+// GETTERS
 // ─────────────────────────────────────────────────────────────
-function getRunner(cmd, styles = {}) {
-  const def = COMMANDS[cmd];
-  if (!def) return null;
-
-  const red = styles.red || "";
-  const reset = styles.reset || "";
-  const errorSym = styles.errorSymbol || "✗";
 
+function getRunner(cmd, opts = {}) {
+  // Resolve alias to canonical command
+  const canonicalCmd = ALIAS_MAP[cmd] || cmd;
+  const def = COMMANDS[canonicalCmd];
+  
+  if (!def) {
+    return null;
+  }
+  
+  if (!def.runner) {
+    return null;
+  }
+  
   try {
     return def.runner();
   } catch (e) {
-    return async () => {
-      console.error(`${red}${errorSym}${reset} Failed to load ${cmd}: ${e.message}`);
-      return 1;
-    };
+    if (opts.red && opts.reset) {
+      console.error(`${opts.red}${opts.errorSymbol || '×'} Failed to load runner for ${cmd}: ${e.message}${opts.reset}`);
+    }
+    return null;
   }
 }
 
+function getCommand(name) {
+  // Check direct name
+  if (COMMANDS[name]) return COMMANDS[name];
+  
+  // Check alias map
+  const canonical = ALIAS_MAP[name];
+  if (canonical && COMMANDS[canonical]) {
+    return { ...COMMANDS[canonical], _resolvedFrom: name, _canonicalName: canonical };
+  }
+  
+  return null;
+}
+
+function resolveCommand(name) {
+  return ALIAS_MAP[name] || name;
+}
+
+// ─────────────────────────────────────────────────────────────
+// EXPORTS
+// ─────────────────────────────────────────────────────────────
 module.exports = {
+  // Core data
   COMMANDS,
+  ALLOWED_COMMANDS,
   ALIAS_MAP,
   ALL_COMMANDS,
+  
+  // Tier helpers
+  isPro,
+  requiresPro,
+  getFreeCommands,
+  getProCommands,
+  
+  // Getters
   getRunner,
+  getCommand,
+  resolveCommand,
+  listCommands: () => Object.keys(COMMANDS),
+  
+  getCommandsByTier: (tier) => 
+    Object.entries(COMMANDS)
+      .filter(([, cmd]) => cmd.tier === tier)
+      .map(([name, cmd]) => ({ name, ...cmd })),
+  
+  getCommandsByCategory: (category) =>
+    Object.entries(COMMANDS)
+      .filter(([, cmd]) => cmd.category === category)
+      .map(([name, cmd]) => ({ name, ...cmd })),
 };