Skip to main content

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 0 when wrapped command succeeds.
  • Returns wrapped command's non-zero exit code when command fails.
  • Returns 2 on configuration errors.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vibecheck_error_assistant_cli-0.1.6.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file vibecheck_error_assistant_cli-0.1.6.tar.gz.

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.6.tar.gz
Algorithm Hash digest
SHA256 3507aec189964e841916cc27f6e610bf5f7fab19b261f3081e1cab52f5e96f01
MD5 c95a5a6b0a069e9377c10be84f244ac4
BLAKE2b-256 b03e7593e32e6173bd3d0c80c36c2ddbdb98e199356b4c64f0a706a2cdf65b5c

See more details on using hashes here.

File details

Details for the file vibecheck_error_assistant_cli-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ada8ddc8a13cbc71b42845c1d9eaa7a351cd6cc6731e7ab99d8faed04118465e
MD5 c6c1adbaa551d1e4c3d85e750ec6a657
BLAKE2b-256 4ee361547ebfae909ab96bae51001ee7e980f086ae35af29dfff3e7497c6b270

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page