🖥️ Command Line Interface

VibeGuard CLI

Powerful command-line tools for security scanning, CI/CD integration, and project management.

Cross-Platform
macOS, Linux, Windows
Open Source
MIT Licensed
CI/CD Ready
Pipeline Integration

📦 Installation

Install the VibeGuard CLI on your preferred platform

Homebrew

brew install vibeguard/tap/vg

Direct Download

curl -sSL https://install.vibeguard.co | bash

NPM Global

npm install -g @vibeguard/cli

🚀 Quick Start

Get started with VibeGuard CLI in under 5 minutes

1️⃣

Install CLI

curl -sSL https://install.vibeguard.co | bash

Download and install the CLI for your platform

2️⃣

Authenticate

vg auth login

Connect to your VibeGuard account

3️⃣

Start Scanning

vg scan

Run your first security scan

📚 Command Reference

Complete reference for all CLI commands and options

Commands

vg scan

Run security scans on your codebase

💡 Examples

vg scan

Scan current directory

vg scan /path/to/project

Scan specific directory

vg scan --type sast,secrets

Run specific scan types

vg scan --output json

Output results in JSON format

vg scan --severity high,critical

Show only high/critical issues

🏁 Flags & Options

--typedefault: all

Scan types: sast, secrets, dependencies, dast

--outputdefault: table

Output format: table, json, sarif, junit

--severitydefault: all

Filter by severity: low, medium, high, critical

--configdefault: .vibeguard.yml

Path to configuration file

--excludedefault: node_modules,dist

Exclude patterns (comma-separated)

--timeoutdefault: 30

Scan timeout in minutes

⚙️ Configuration

Customize VibeGuard CLI behavior with configuration files

📄 .vibeguard.yml

Project-level configuration file

# VibeGuard CLI Configuration
version: "1.0"

# Scan Configuration
scan:
  types:
    - sast
    - secrets
    - dependencies
  severity_threshold: "medium"
  timeout: 30
  
# Exclusions
exclude:
  paths:
    - "node_modules/**"
    - "dist/**"
    - "*.test.js"
  files:
    - ".env.example"
    
# Output Settings
output:
  format: "table"
  colors: true
  verbose: false
  
# API Configuration
api:
  endpoint: "https://api.vibeguard.co"
  timeout: 60
  
# CI/CD Integration
ci:
  fail_on: "high"
  upload_results: true

🌍 Environment Variables

Configure CLI behavior via environment

VIBEGUARD_API_KEY

Your VibeGuard API authentication token

VIBEGUARD_ORG_ID

Organization ID for team accounts

VIBEGUARD_CONFIG_FILE

Path to custom config file

VIBEGUARD_API_ENDPOINT

Custom API endpoint URL

VIBEGUARD_TIMEOUT

Request timeout in seconds

VIBEGUARD_NO_COLOR

Disable colored output (set to 1)

🔄 CI/CD Integration

Integrate security scanning into your development workflow

🐙

GitHub Actions

name: Security Scan
on: [push, pull_request]

jobs:
  security:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run VibeGuard Scan
        run: |
          curl -sSL https://install.vibeguard.co | bash
          vg auth token ${{ secrets.VIBEGUARD_TOKEN }}
          vg scan --output sarif > results.sarif
      - name: Upload SARIF
        uses: github/codeql-action/upload-sarif@v2
        with:
          sarif_file: results.sarif
🦊

GitLab CI/CD

security_scan:
  stage: test
  image: ubuntu:latest
  script:
    - curl -sSL https://install.vibeguard.co | bash
    - vg auth token $VIBEGUARD_TOKEN
    - vg scan --output json > security-report.json
  artifacts:
    reports:
      security:
        - security-report.json
    expire_in: 1 week
  only:
    - branches
👷

Jenkins Pipeline

pipeline {
  agent any
  stages {
    stage('Security Scan') {
      steps {
        sh 'curl -sSL https://install.vibeguard.co | bash'
        withCredentials([string(credentialsId: 'vibeguard-token', variable: 'VG_TOKEN')]) {
          sh 'vg auth token $VG_TOKEN'
          sh 'vg scan --output junit > security.xml'
        }
      }
      post {
        always {
          junit 'security.xml'
        }
      }
    }
  }
}

🤝 Help & Resources

Get help and learn more about the VibeGuard CLI

📖

Built-in Help

vg --help

Get help for any command with the --help flag

🐛

Report Issues

GitHub Issues

Found a bug or have a feature request?

💬

Community Support

Join Discord

Get help from the community