Skip to content

eshaanag/vibeguard

Repository files navigation

VibeGuard Prototype

VibeGuard is a minimal, ultra-fast security scanner that identifies secrets (API keys, tokens, passwords) in your GitHub repositories or ZIP uploads. It runs entirely locally on your machine, ensuring your code never leaves your environment.

Features

  • AI Remediation: Powered by Gemini Pro, providing explanations, fix steps, and secure code.
  • URL & ZIP Support: Input any public GitHub URL or upload a ZIP file.
  • Dual Pipeline: Uses Gitleaks as primary scanner with a high-speed Node.js Regex fallback.
  • Risk Scoring & AI Summary: Weighted risk score + Gemini-powered executive summary.
  • Interactive Dashboard: Modern UI with real-time feedback and remediation hints.
  • Privacy First: All scans run locally; ephemeral directories are deleted immediately.

Quick Start (macOS, Linux, Windows)

Prerequisites

  • Node.js (v18+)
  • Git
  • (Optional) Gitleaks for enhanced scanning.

Installation & Run

  1. Clone & Install Dependencies

    npm install
  2. Run the Development Server

    npm run dev
  3. Open the Dashboard Navigate to http://localhost:3000

  4. Demo Mode The prototype includes DEMO_MODE=true in .env.local which prefers cached AI responses for instant demonstration.

Demo Script

Refer to DEMO_SCRIPT_AI.md for the AI-powered presentation script.

Fallback Plan

If you encounter network or environment issues:

Safety Disclaimer

This is a prototype. Always verify findings manually. Scanned data is stored in tmp/ and wiped after each session.

About

VibeGuard - Automated Security Auditor

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors