VibeCheck

Professional AI Code Review & Analysis Tool

VibeCheck is a premium AI-powered code review tool that analyzes your git changes and provides comprehensive feedback on code quality, security, and best practices. Built for professional development teams who demand excellence.

✨ Features

🔍 Intelligent Code Review

• ESLint-style output with file-grouped issues and line numbers
• Multi-language support - automatically detects frameworks and languages
• Security analysis - detects vulnerabilities, hardcoded secrets, and injection risks
• Performance insights - identifies bottlenecks and optimization opportunities
• Code quality metrics - comprehensive scoring across multiple dimensions

📊 Professional Output Formats

• Pretty mode (default): Clean, colorized terminal output
• JSON mode: Machine-readable format for CI/CD integration
• Markdown mode: Perfect for pull request comments and documentation

🎯 Comprehensive Analysis

• File analysis: Deep dive into individual files with strengths and risks
• Change analysis: Review git diffs with context-aware suggestions
• Quality scoring: Overall code quality metrics (0-100 scale)
• Test recommendations: Actionable testing strategies

🚀 Installation

Option 1: Global Installation (Recommended)

npm install -g vibecodingreviewer

Option 2: Project-specific Installation

npm install --save-dev vibecodingreviewer
npx vibecheck run

🔑 Authentication

VibeCheck supports two authentication models:

Bring Your Own Key (BYOK)

Use your own OpenAI API key for maximum control and cost transparency:

export OPENAI_API_KEY=your_openai_api_key_here

Benefits:

• Direct billing to your OpenAI account
• Full control over usage and costs
• No additional fees from VibeCheck
• Access to latest OpenAI models

Subscription Model (Coming Soon)

Managed API access with usage-based pricing:

vibecheck auth --subscription-key your_subscription_key

Benefits:

• No OpenAI account required
• Predictable monthly pricing
• Usage analytics and reporting
• Priority support

📖 Commands

vibecheck run

Review your uncommitted changes with comprehensive analysis.

# Review uncommitted changes
vibecheck run

# Review with different output formats
vibecheck run --pretty    # Default: formatted output
vibecheck run --json      # Machine-readable JSON
vibecheck run --markdown  # Markdown for PR comments

# Review committed changes
vibecheck run --commits

# Review all changes (uncommitted + committed)
vibecheck run --all

Options:

• --pretty: Formatted output with colors and icons (default)
• --json: JSON output for automation and CI/CD
• --markdown: Markdown format for documentation
• --commits: Review only committed changes since base branch
• --all: Review both uncommitted and committed changes
• --share: Generate shareable summary for social media

vibecheck explain <file>

Deep analysis of individual files with strengths, risks, and recommendations.

# Analyze a specific file
vibecheck explain src/main.go

# Different output formats
vibecheck explain src/main.go --json
vibecheck explain src/main.go --markdown

# Explain specific line (coming soon)
vibecheck explain src/main.go --line 42

Options:

• --pretty: Formatted analysis (default)
• --json: JSON format for programmatic use
• --markdown: Markdown format for documentation
• --line <number>: Explain specific line from last run (coming soon)

📊 Output Examples

Pretty Mode (Default)

❌ src/auth.js
   [Line 15] Hardcoded API key detected
   [Line 42] SQL injection vulnerability

⚠️ src/utils.js
   [Line 8] Missing error handling

📝 Summary:
  Files checked: 2 | Issues found: 3 (❌ 2, ⚠️ 1)
  Overall Code Quality: 75/100

JSON Mode

{
  "violations": [
    {
      "file": "src/auth.js",
      "start": 15,
      "end": 15,
      "rule": "Hardcoded API key",
      "severity": "critical",
      "reason": "API key should be stored in environment variables",
      "patch": "Use process.env.API_KEY instead"
    }
  ],
  "stats": {
    "filesChecked": 2,
    "totalIssues": 3,
    "criticalIssues": 2,
    "warningIssues": 1,
    "overallQuality": 75
  }
}

Markdown Mode

## 🔍 VibeCheck Code Review

| Metric | Count |
|--------|-------|
| Files checked | 2 |
| Total issues | 3 |
| Critical | 2 |
| Warnings | 1 |
| Quality score | 75/100 |

### 📁 src/auth.js
❌ **Line 15**: Hardcoded API key detected
   API key should be stored in environment variables
   **Fix**: Use process.env.API_KEY instead

🎯 Use Cases

Individual Developers

• Pre-commit code quality checks
• Learning best practices through AI feedback
• Security vulnerability detection

Development Teams

• Consistent code review standards
• Automated quality gates in CI/CD
• Knowledge sharing through detailed analysis

Open Source Projects

• Automated PR analysis
• Contributor onboarding assistance
• Code quality documentation

🔧 Configuration

VibeCheck automatically detects your project structure and adapts accordingly. For advanced configuration, create a .vibecheck.yml file:

# .vibecheck.yml
llm:
  model: "gpt-4o-mini"  # or "gpt-4o", "gpt-3.5-turbo"
  monthly_tokens: 100000

output:
  format: "pretty"  # pretty, json, markdown
  show_quality: true
  show_summary: true

filters:
  ignore_patterns:
    - "node_modules/**"
    - "dist/**"
    - "*.log"

💡 Best Practices

For Maximum Value

1. Run before commits: Catch issues early in your workflow
2. Use JSON mode in CI/CD: Integrate with your automation pipeline
3. Review explain output: Learn from detailed file analysis
4. Set up quality gates: Use quality scores as deployment criteria

Integration Examples

Pre-commit Hook:

# .git/hooks/pre-commit
#!/bin/bash
vibecheck run --json | jq '.stats.totalIssues'
if [ $? -ne 0 ] || [ $(vibecheck run --json | jq '.stats.criticalIssues') -gt 0 ]; then
  echo "❌ Critical issues found. Commit blocked."
  exit 1
fi

GitHub Actions:

- name: VibeCheck Analysis
  run: |
    npm install -g vibecodingreviewer
    vibecheck run --markdown > vibecheck-report.md
  env:
    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

🆘 Support

• Documentation: GitHub Repository
• Issues: GitHub Issues
• Discussions: GitHub Discussions

📄 License

MIT License - see LICENSE file for details.

VibeCheck - Elevate your code quality with AI-powered insights. 🚀