Vibesweep Documentation
Welcome to Vibesweep - your AI code waste detector and cleaner. Vibesweep helps you identify and remove AI-generated code artifacts, dead code, and duplications from your codebase.
What is Vibesweep?
Vibesweep is a powerful CLI tool that analyzes your codebase to detect:
- ๐ค AI-generated code patterns - Identifies telltale signs of LLM-generated code
- ๐ Dead code - Finds unused functions, variables, and imports
- ๐ Code duplication - Detects copy-pasted code blocks
- ๐ TODO/FIXME tracking - Extracts and reports on code debt markers
- ๐งน Safe automated fixes - Removes console.logs and other artifacts safely
Quick Start
# Install globally
npm install -g vibesweep
# Analyze your project
vibesweep analyze .
# View detailed file analysis
vibesweep analyze src/ --output json
# Extract TODOs
vibesweep todos .
Documentation
Getting Started
Features
Configuration
CLI Reference
Advanced Topics
Troubleshooting
Why Vibesweep?
Modern development with AI assistants like GitHub Copilot and ChatGPT has revolutionized coding speed, but it comes with a hidden cost: AI-generated code waste.
The Problem
- Verbose patterns: AI often generates unnecessarily verbose code
- Redundant comments: Over-documented obvious code
- Debug artifacts: Leftover console.logs and debug statements
- Duplicate solutions: Similar code patterns repeated across files
- Dead code: Unused functions and variables that accumulate over time
The Solution
Vibesweep uses advanced AST parsing and pattern recognition to:
- Identify AI-generated code patterns with high accuracy
- Analyze your codebase for waste and inefficiencies
- Report actionable insights with clear metrics
- Fix safe issues automatically (with your approval)
Getting Help
- ๐ง Email: support@vibesweep.ai
- ๐ฌ Discord: Join our community
- ๐ Issues: GitHub Issues
- ๐ Blog: Best practices and tips