Understand the code your AI wrote
Project description
"VibeCheck: The Virtual Senior Developer in Your Terminal"
AI-Powered Code Auditing with a "Senior Developer" Vibe.
VibeCheck is an interactive CLI tool designed to help developers understand, audit, and secure their codebase. It combines strict rule-based scanning with advanced AI explanations to ensure you don't just fix bugs—you learn from them.
🎬 Cinematic Walkthrough
| 1. Project-Specific Rules |
2. Security Audit |
| 3. Educational Analogies (ELI5) |
4. Security Deep-Dive |
| 5. Concept Memory Tracking |
6. AI Fix Suggestions |
| 7. Interactive Chat Mode |
Ready for Launch |
✨ Key Features
🛡️ Rule-Based Engine & Local Guidelines
VibeCheck doesn't just use AI; it uses a strict engine to catch SQL Injections, Hardcoded Credentials, and more. Most importantly, it reads your .vibecheck_rules.md to enforce your team's specific coding standards.
🧠 Smart Global Caching
Performance matters. VibeCheck caches every AI response in your home directory (~/.vibecheck/cache). Scan once, and the next scan is instant and completely free.
🎓 Pedagogical AI (ELI5)
Switch to --learn mode to get complex technical flaws explained through simple real-world analogies. Perfect for junior developers and students.
💬 Interactive Terminal Chat
Don't understand a specific issue? Launch --chat mode to have a direct conversation with the "Virtual Senior Developer" about your code.
🚀 Quick Start
1. Installation
pip install vibecheck-ai-tool
2. Configure API Key
VibeCheck is universal. It automatically detects your provider.
| Provider | Environment Variable | Default Model |
|---|---|---|
| Groq (Fastest) | GROQ_API_KEY |
llama-3.3-70b |
| OpenAI | OPENAI_API_KEY |
gpt-4o-mini |
| Anthropic | ANTHROPIC_API_KEY |
claude-3.5-sonnet |
GOOGLE_API_KEY |
gemini-1.5-pro |
|
| Ollama | VIBECHECK_ENTERPRISE_MODE=1 |
ollama/llama3 |
# Example for Groq
$env:GROQ_API_KEY = "your-key-here"
3. Run Your First Audit
vibecheck examples/python_bad.py --learn
👨💻 Developed by a 16-Year-Old Creator
Created in 24 hours to prove that AI tools should focus on education, not just automation. Architected & Maintained by Afif Erdita.
📄 License
MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vibecheck_ai_tool-1.0.2.tar.gz.
File metadata
- Download URL: vibecheck_ai_tool-1.0.2.tar.gz
- Upload date:
- Size: 35.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d9c27bfc476ba9e06fb5be6ea0350f61aa6ed54559c276b76763cdf8b9f4f78
|
|
| MD5 |
01d83863643a4e9cb8fe3d5ef0923ba6
|
|
| BLAKE2b-256 |
469497d15f0f38e30bccf435397fb5ac2a3047676872c59075140d6bae44370e
|
File details
Details for the file vibecheck_ai_tool-1.0.2-py3-none-any.whl.
File metadata
- Download URL: vibecheck_ai_tool-1.0.2-py3-none-any.whl
- Upload date:
- Size: 32.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
abd5de9b56d67e7f1cc01b2da23623181e2c12a6619d36b57a2bd400837176c6
|
|
| MD5 |
9aca01f4f9e6d740a98bd5af245fdd7b
|
|
| BLAKE2b-256 |
7967b8156bfe020464bd1c7b82740220ecfbf57be6d2743afd4814bfc70e19a3
|