Metadata-Version: 2.4
Name: vibecheck-error-assistant-cli
Version: 0.1.9
Summary: Run commands and translate programming errors into beginner-friendly explanations
Author: VibeCheck
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: openai==2.30.0
Requires-Dist: rich==14.3.3
Requires-Dist: python-dotenv==1.2.2

# VibeCheck ✨

**Bad vibes? Fixed. Instantly.**

VibeCheck is a CLI tool that runs your terminal commands, catches failures, and translates technical errors into beginner-friendly, human-readable guidance using GitHub Models AI.

## Features
- **Automatic Error Interception:** Catches errors right away when your command fails.
- **Skill-Leveled Explanations:** Choose `--level beginner`, `intermediate`, or `advanced`.
- **Auto Code Detection:** Just type `vibecheck index.js` and it knows how to run it.
- **GitHub AI Powered:** Free, fast, and high-quality error explanations.
- **Beautiful Terminal UI:** Clean and colorful output right in your terminal.

## Installation

Install globally using `pipx` (recommended):

```bash
# 1. Install pipx if you haven't already
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# 2. Install VibeCheck
pipx install vibecheck-error-assistant-cli
```

*Note: Restart your terminal after installing `pipx` for the first time.*

## Configuration

Run the setup wizard to configure your GitHub token. This saves your credentials globally so VibeCheck works across all your projects.

``` bash
vibecheck setup
```
*You only need to do this once!*

## Usage

Simply add `vibecheck` before any command you want to run.

```bash
# Node.js
vibecheck node app.js

# Python
vibecheck python script.py
```

### Explanation Levels

You can customize how detailed the AI explanation is:

```bash
vibecheck --level beginner node app.js
vibecheck --level intermediate python script.py
vibecheck --level advanced go run main.go
```

### See the Raw Error

If you also want to see the standard messy error output along with the AI explanation:

```bash
vibecheck --print-raw-error python script.py
```

## Links
- [VibeCheck on GitHub](https://github.com/adasbear/VibeCheck)
- [VibeCheck on PyPI](https://pypi.org/project/vibecheck-error-assistant-cli/)
