Run commands and translate programming errors into beginner-friendly explanations
Project description
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, oradvanced. - Auto Code Detection: Just type
vibecheck index.jsand 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):
# 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.
vibecheck setup
You only need to do this once!
Usage
Simply add vibecheck before any command you want to run.
# Node.js
vibecheck node app.js
# Python
vibecheck python script.py
Explanation Levels
You can customize how detailed the AI explanation is:
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:
vibecheck --print-raw-error python script.py
Links
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_error_assistant_cli-0.1.9.tar.gz.
File metadata
- Download URL: vibecheck_error_assistant_cli-0.1.9.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7f02579e8697a8d9895c7c326823b80f9414ccfe8497b3f4a2b138fc98f17861
|
|
| MD5 |
774bf9de9ca6a32136370ebbcb15f4bf
|
|
| BLAKE2b-256 |
0c0ed7df6d8d53ec10650ced9b05d53693373c025c8b57207c163332c9495eb3
|
File details
Details for the file vibecheck_error_assistant_cli-0.1.9-py3-none-any.whl.
File metadata
- Download URL: vibecheck_error_assistant_cli-0.1.9-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b54af149b60d5e8f5495ea31a8e9f5893c3f2abe4bd7f95f64216eeb23febb72
|
|
| MD5 |
9c5e34c9bf230ee372e85afb20e603d4
|
|
| BLAKE2b-256 |
09003e3ac8bcf39c1776b6e68037b14ea1c36af9a5abc68360b750199a49a89c
|