Metadata-Version: 2.4
Name: vibecheck-ai-tool
Version: 1.0.2
Summary: Understand the code your AI wrote
Author: vibecheck contributors
License: MIT
Keywords: cli,code-review,ai,education,developer-tools
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.12.0
Requires-Dist: rich>=13.0.0
Requires-Dist: litellm>=1.0.0
Requires-Dist: pyyaml>=6.0
Dynamic: license-file

<p align="center">
  <img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/logo.jpg" alt="VibeCheck Logo" width="400">
</p>

<h2 align="center">"VibeCheck: The Virtual Senior Developer in Your Terminal"</h2>

<p align="center">
  <a href="https://pypi.org/project/vibecheck-ai-tool/"><img src="https://img.shields.io/pypi/v/vibecheck-ai-tool?color=black&labelColor=gray&style=for-the-badge" alt="PyPI"></a>
  <a href="https://pypi.org/project/vibecheck-ai-tool/"><img src="https://img.shields.io/pypi/pyversions/vibecheck-ai-tool?color=black&labelColor=gray&style=for-the-badge" alt="Python Versions"></a>
  <a href="https://github.com/apiprdt/vibecheck/blob/main/LICENSE"><img src="https://img.shields.io/github/license/apiprdt/vibecheck?color=black&labelColor=gray&style=for-the-badge" alt="License"></a>
</p>

<p align="center">
  <a href="https://github.com/apiprdt/vibecheck"><img src="https://img.shields.io/badge/PRs-Welcome-black?labelColor=gray&style=for-the-badge" alt="PRs Welcome"></a>
  <a href="https://github.com/apiprdt/vibecheck"><img src="https://img.shields.io/github/stars/apiprdt/vibecheck?color=black&labelColor=gray&style=for-the-badge" alt="Stars"></a>
  <a href="https://x.com/AfifErditaa"><img src="https://img.shields.io/badge/X%20(Twitter)-@AfifErditaa-black?logo=x&logoColor=white&labelColor=gray&style=for-the-badge" alt="Twitter"></a>
  <a href="https://instagram.com/afiferdita"><img src="https://img.shields.io/badge/Instagram-@afiferdita-black?logo=instagram&logoColor=white&labelColor=gray&style=for-the-badge" alt="Instagram"></a>
</p>

---

### **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

<table align="center">
  <tr>
    <td align="center"><b>1. Project-Specific Rules</b><br/><img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/vibe1.png" width="400"></td>
    <td align="center"><b>2. Security Audit</b><br/><img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/vibe2.png" width="400"></td>
  </tr>
  <tr>
    <td align="center"><b>3. Educational Analogies (ELI5)</b><br/><img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/vibe3.png" width="400"></td>
    <td align="center"><b>4. Security Deep-Dive</b><br/><img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/vibe4.png" width="400"></td>
  </tr>
  <tr>
    <td align="center"><b>5. Concept Memory Tracking</b><br/><img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/vibe5.png" width="400"></td>
    <td align="center"><b>6. AI Fix Suggestions</b><br/><img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/vibe6.png" width="400"></td>
  </tr>
  <tr>
    <td align="center"><b>7. Interactive Chat Mode</b><br/><img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/vibe7.png" width="400"></td>
    <td align="center"><b>Ready for Launch</b><br/><img src="https://raw.githubusercontent.com/apiprdt/VibeCheck/main/assets/logo.jpg" width="400"></td>
  </tr>
</table>

---

## ✨ 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
```bash
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** | `GOOGLE_API_KEY` | `gemini-1.5-pro` |
| **Ollama** | `VIBECHECK_ENTERPRISE_MODE=1` | `ollama/llama3` |

```powershell
# Example for Groq
$env:GROQ_API_KEY = "your-key-here"
```

### 3. Run Your First Audit
```bash
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](https://github.com/apiprdt).

---

## 📄 License
MIT License.
