GET STARTED IN 30 SECONDS

Choose your preferred installation method and start scanning for security vulnerabilities immediately.

1

Install Vibe-Guard

Install globally using npm or use npx for one-time usage.

Terminal
# Install globally npm install -g vibe-guard # Or use npx (no installation needed) npx vibe-guard scan .
2

Scan Your Project

Run a security scan on your codebase.

Terminal
# Scan current directory vibe-guard scan . # Scan specific file vibe-guard scan src/app.js # Get JSON output for CI/CD vibe-guard scan . --format json
3

Review Results

Vibe-Guard will show you detailed vulnerability reports with file locations and remediation guidance.

✅ Success! You're now ready to scan your projects for security vulnerabilities.
1

Install via Homebrew

Install Vibe-Guard using Homebrew package manager.

Terminal
# Install Vibe-Guard brew install devjosef/tap/vibe-guard
2

Start Scanning

Use the same commands as npm installation.

Terminal
# Scan your project vibe-guard scan . # Check version vibe-guard --version
1

Download Binary

Download the appropriate binary for your platform from GitHub releases.

Terminal
# macOS (Intel) curl -L -o vibe-guard https://github.com/Devjosef/vibe-guard/releases/latest/download/vibe-guard-macos-x64 # macOS (Apple Silicon) curl -L -o vibe-guard https://github.com/Devjosef/vibe-guard/releases/latest/download/vibe-guard-macos-arm64 # Linux (x64) curl -L -o vibe-guard https://github.com/Devjosef/vibe-guard/releases/latest/download/vibe-guard-linux-x64 # Windows curl -L -o vibe-guard.exe https://github.com/Devjosef/vibe-guard/releases/latest/download/vibe-guard-windows-x64.exe
2

Make Executable & Run

Make the binary executable and start scanning.

Terminal
# Make executable (macOS/Linux) chmod +x vibe-guard # Run scan ./vibe-guard scan . # Or move to PATH sudo mv vibe-guard /usr/local/bin/
1

Pull Docker Image

Pull the official Vibe-Guard Docker image.

Terminal
# Pull latest image docker pull devjosef/vibe-guard:latest
2

Run Container

Mount your project directory and run the scan.

Terminal
# Scan current directory docker run --rm -v $(pwd):/app devjosef/vibe-guard:latest scan /app # Or use docker-compose docker-compose run --rm vibe-guard scan .

COMMON USAGE EXAMPLES

Basic Scan

Scan your entire project for security vulnerabilities.

vibe-guard scan .

Specific Files

Scan specific files or directories.

vibe-guard scan src/ vibe-guard scan app.js config.js

Exclude Files

Exclude certain files or directories from scanning.

vibe-guard scan . --exclude node_modules,dist

JSON Output

Get results in JSON format for CI/CD integration.

vibe-guard scan . --format json > results.json

List Rules

View all available security rules.

vibe-guard rules

Custom Rules

Use custom rule patterns for specific needs.

vibe-guard scan . --pattern "password.*=.*['\"]"
💡 Pro Tip: Add Vibe-Guard to your CI/CD pipeline to automatically scan for vulnerabilities on every commit or pull request.
View Security Rules
← Back to Home