Quickstart

Get up and running with VibeGuard in under a minute to secure your AI-generated code.

1. Initialize Configuration

First, create a basic configuration file for your project. This creates a .vibeguard.yaml file in your current directory with sensible defaults.

npx vibeguard-scan init

2. Run a Security Scan

Now that you have a config file, initiate a scan of your entire project directory.

npx vibeguard-scan scan .

VibeGuard will analyze your Abstract Syntax Trees (ASTs) and output a detailed report, granting your project a Vibe Code Safety Score (0-100).

3. Interactive Auto-Fixer

Did VibeGuard find a leaked password, an exposed API key, or a vulnerability? Tell it to fix it!

npx vibeguard-scan fix .

VibeGuard will interactively step through the detected vulnerabilities and seamlessly drop environment variables or patches directly into your code.

4. MCP Server Setup (Optional)

If you use AI code editors like Cursor or AI agents like Claude Desktop, you can attach VibeGuard directly to them so they can scan their own code as they write it!

npx -y vibeguard-scan mcp

Just add this command as an MCP Server in your editor settings.