Run commands and translate programming errors into beginner-friendly explanations
Project description
VibeCheck CLI
VibeCheck runs your command, catches failures, and translates technical stderr into beginner-friendly guidance.
Install (Global)
Install once, use in all projects:
python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install vibecheck-error-assistant-cli
Restart terminal once after ensurepath.
On first run, VibeCheck will guide you through setup and save your provider/token globally in ~/.config/vibecheck/.env.
Configure Token
Option A: per-project .env file:
VIBECHECK_GITHUB_TOKEN=your_token_here
VIBECHECK_ENDPOINT=https://models.inference.ai.azure.com
Option B: global shell variables in ~/.bashrc:
export VIBECHECK_GITHUB_TOKEN="your_token_here"
export VIBECHECK_ENDPOINT="https://models.inference.ai.azure.com"
source ~/.bashrc
Or run the built-in setup wizard:
vibecheck setup
Usage
Single command mode:
vibecheck node app.js
vibecheck python app.py
Interactive mode (tool waits in terminal):
vibecheck --shell
Exit interactive mode with exit or quit.
Useful Flags
vibecheck --level beginner python app.py
vibecheck --level advanced node app.js
vibecheck --print-raw-error python app.py
Developer Install (Contributors)
From project root:
python3 -m venv .venv
source .venv/bin/activate
pip install -e .
Exit Codes
- Returns
0when wrapped command succeeds. - Returns wrapped command's non-zero exit code when command fails.
- Returns
2on configuration errors.
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.5.tar.gz.
File metadata
- Download URL: vibecheck_error_assistant_cli-0.1.5.tar.gz
- Upload date:
- Size: 7.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b71ac229f8878948550380de1039473d7c29ce90564372de28c7e6f438768839
|
|
| MD5 |
e022dc1687c139f978f1372dcdd8dc9b
|
|
| BLAKE2b-256 |
12b1a23ccf4aed8a3d6f85aac6f59be0ffa8656aaaab26aaa2b19c5e8c523fe8
|
File details
Details for the file vibecheck_error_assistant_cli-0.1.5-py3-none-any.whl.
File metadata
- Download URL: vibecheck_error_assistant_cli-0.1.5-py3-none-any.whl
- Upload date:
- Size: 8.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
069e95761593dc92af09ff4914ed27193a4e094a6ee4fe759366841ab9bf8070
|
|
| MD5 |
6777993a888685db450566ee0ac9388e
|
|
| BLAKE2b-256 |
13776c5c5ce093050098c46c6bb576b26402c6c6d7bdf8c963a82b855e19bffd
|