@vibecheckai/cli 3.4.0 → 3.5.0

package/bin/runners/lib/easy/README.md

@@ -0,0 +1,123 @@
+# Vibecheck Easy Mode
+
+**The simplest way to use Vibecheck.** No coding knowledge required.
+
+---
+
+## Getting Started
+
+Just run this in your project folder:
+
+```bash
+npx vibecheck
+```
+
+That's it! An interactive wizard will guide you through everything.
+
+---
+
+## Commands
+
+### Test Your App (Reality Mode)
+
+```bash
+npx vibecheck test
+```
+
+This opens your app in a browser and tests it like a real user would:
+- Clicks all the buttons
+- Fills out forms
+- Checks if everything works
+- Creates a report of any issues found
+
+**Have a specific URL?**
+```bash
+npx vibecheck test http://localhost:3000
+```
+
+---
+
+### Protect Your Code (Firewall)
+
+```bash
+npx vibecheck protect
+```
+
+This sets up automatic protection that:
+- Watches your code as you write it
+- Warns you about security issues
+- Blocks bad code from being committed
+- Learns from your feedback
+
+**Turn it off:**
+```bash
+npx vibecheck protect --off
+```
+
+---
+
+### Check Status
+
+```bash
+npx vibecheck status
+```
+
+See what's currently enabled.
+
+---
+
+## What Gets Detected?
+
+### Security Issues
+- Passwords in your code (should be in environment variables)
+- SQL injection vulnerabilities
+- Cross-site scripting (XSS) risks
+
+### Quality Issues
+- Fake/mock data that shouldn't be in production
+- `console.log` statements (debugging leftovers)
+- TODO comments that need attention
+
+### Suggestions
+- Missing error handling
+- TypeScript `any` types
+- Magic numbers (unexplained constants)
+
+---
+
+## Reports
+
+After testing, find your report at:
+```
+vibecheck-report.html
+```
+
+Just open it in your browser to see the full results.
+
+---
+
+## Need Help?
+
+- Run `npx vibecheck help` for more options
+- Visit [vibecheck.dev/docs](https://vibecheck.dev/docs)
+- Email support@vibecheck.dev
+
+---
+
+## Modes
+
+| Mode | Description |
+|------|-------------|
+| `protect` | Block critical issues, warn about others (default) |
+| `monitor` | Only warn, don't block anything |
+| `strict` | Block everything, including suggestions |
+
+Set mode when enabling:
+```bash
+npx vibecheck protect --strict
+npx vibecheck protect --monitor
+```
+
+---
+
+Made with ♥ by the Vibecheck team

package/bin/runners/lib/easy/index.js

@@ -0,0 +1,140 @@
+/**
+ * Easy Mode - Unified Export
+ * 
+ * ═══════════════════════════════════════════════════════════════════════════════
+ * EVERYTHING YOU NEED FOR ZERO-FRICTION VIBECHECK
+ * ═══════════════════════════════════════════════════════════════════════════════
+ * 
+ * This module exports all the easy-to-use components:
+ * 
+ * 1. Interactive Wizard - Guided setup for new users
+ * 2. Zero-Config Reality - One command to test your app
+ * 3. One-Click Firewall - Instant protection
+ */
+
+"use strict";
+
+// Interactive Wizard
+const {
+  Wizard,
+  showWelcomeBanner,
+  colors,
+  icons
+} = require("./interactive-wizard");
+
+// Zero-Config Reality Mode
+const {
+  ZeroConfigReality,
+  ProjectDetector,
+  ServerManager,
+  SimpleOutput
+} = require("./zero-config-reality");
+
+// One-Click Firewall
+const {
+  OneClickFirewall,
+  quickCheck,
+  DEFAULT_FIREWALL_CONFIG
+} = require("./one-click-firewall");
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// SUPER SIMPLE API
+// ═══════════════════════════════════════════════════════════════════════════════
+
+/**
+ * Start the interactive wizard
+ * @example
+ * const { startWizard } = require('vibecheck/easy');
+ * startWizard();
+ */
+async function startWizard() {
+  const wizard = new Wizard();
+  return wizard.start();
+}
+
+/**
+ * Test your app with zero configuration
+ * @param {string} [url] - Optional URL to test (auto-detects if not provided)
+ * @example
+ * const { testApp } = require('vibecheck/easy');
+ * testApp(); // Auto-detects your app
+ * testApp('http://localhost:3000'); // Test specific URL
+ */
+async function testApp(url) {
+  const reality = new ZeroConfigReality({ url });
+  return reality.run();
+}
+
+/**
+ * Enable firewall protection with one line
+ * @param {Object} [options] - Configuration options
+ * @param {string} [options.mode='protect'] - 'monitor' | 'protect' | 'strict'
+ * @example
+ * const { enableProtection } = require('vibecheck/easy');
+ * enableProtection(); // Enable with defaults
+ * enableProtection({ mode: 'strict' }); // Enable strict mode
+ */
+async function enableProtection(options = {}) {
+  const firewall = new OneClickFirewall(options);
+  return firewall.enable();
+}
+
+/**
+ * Disable firewall protection
+ * @example
+ * const { disableProtection } = require('vibecheck/easy');
+ * disableProtection();
+ */
+async function disableProtection() {
+  const firewall = new OneClickFirewall();
+  return firewall.disable();
+}
+
+/**
+ * Get current status
+ * @example
+ * const { getStatus } = require('vibecheck/easy');
+ * const status = await getStatus();
+ */
+async function getStatus() {
+  const firewall = new OneClickFirewall({ quiet: true });
+  return firewall.status();
+}
+
+/**
+ * Quick check files (used by git hooks)
+ * @param {Object} options
+ * @param {boolean} options.staged - Check only staged files
+ */
+async function checkFiles(options = {}) {
+  return quickCheck(options);
+}
+
+// ═══════════════════════════════════════════════════════════════════════════════
+// EXPORTS
+// ═══════════════════════════════════════════════════════════════════════════════
+
+module.exports = {
+  // Super simple API
+  startWizard,
+  testApp,
+  enableProtection,
+  disableProtection,
+  getStatus,
+  checkFiles,
+  
+  // Classes (for advanced usage)
+  Wizard,
+  ZeroConfigReality,
+  OneClickFirewall,
+  ProjectDetector,
+  ServerManager,
+  SimpleOutput,
+  
+  // Utilities
+  colors,
+  icons,
+  showWelcomeBanner,
+  quickCheck,
+  DEFAULT_FIREWALL_CONFIG
+};