Quick Start Guide

Get up and running with Vibesweep in 5 minutes!

Your First Analysis

Navigate to your project directory and run:

vibesweep analyze .

This will analyze all JavaScript and TypeScript files in your project and show you:

Total waste percentage
Number of files with issues
Top waste offenders
Potential savings in lines of code and disk space

Understanding the Output

🧹 Vibesweep Analysis Report
──────────────────────────────────────────────────

📊 Overview:
  Total files analyzed: 142
  Total size: 1.2MB
  Total waste: 156KB
  Waste percentage: 13%

📈 Summary:
  Files with dead code: 23
  Files with duplications: 8
  AI-generated files: 45

💰 Potential Savings:
  Lines of code: 1,234
  Disk space: 156KB

🚨 Top Waste Offenders:

  1. src/utils/helpers.js
     Waste Score: 67%
     Dead Code: 45%
     Duplication: 12%
     AI Score: 89/100
     Patterns: verbose-conditionals

  2. src/components/UserList.tsx
     Waste Score: 54%
     Dead Code: 23%
     Duplication: 31%
     AI Score: 76/100

Common Commands

Analyze specific directories

# Analyze only the src directory
vibesweep analyze src/

# Analyze multiple directories
vibesweep analyze src/ lib/ utils/

Change output format

# Get JSON output for parsing
vibesweep analyze . --output json

# Include TODO/FIXME report
vibesweep analyze . --todos

Filter by file patterns

# Analyze only TypeScript files
vibesweep analyze . --pattern "**/*.ts"

# Analyze React components
vibesweep analyze . --pattern "**/*.{jsx,tsx}"

Extract TODOs

Find all TODO and FIXME comments:

vibesweep todos .

# Output as markdown
vibesweep todos . --markdown

Safe Fix (Beta)

Remove console.log statements safely:

# Preview what would be removed (dry run)
vibesweep fix . --dry-run

# Apply fixes with confirmation
vibesweep fix .

# Skip git check (not recommended)
vibesweep fix . --no-git-check

What's Next?

Configure Vibesweep: Create a .vibesweeprc.json file
Understand patterns: Learn about AI detection patterns
Integrate with CI: Set up CI/CD integration
Customize: Define custom patterns for your team

Tips for Best Results

Start small: Analyze a single directory first to understand the reports
Regular scans: Run Vibesweep weekly to prevent waste accumulation
Team adoption: Share reports with your team to establish coding standards
Gradual cleanup: Don't try to fix everything at once - prioritize high-waste files