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.5.tar.gz (7.8 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.5.tar.gz.

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.5.tar.gz
Algorithm Hash digest
SHA256 b71ac229f8878948550380de1039473d7c29ce90564372de28c7e6f438768839
MD5 e022dc1687c139f978f1372dcdd8dc9b
BLAKE2b-256 12b1a23ccf4aed8a3d6f85aac6f59be0ffa8656aaaab26aaa2b19c5e8c523fe8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 069e95761593dc92af09ff4914ed27193a4e094a6ee4fe759366841ab9bf8070
MD5 6777993a888685db450566ee0ac9388e
BLAKE2b-256 13776c5c5ce093050098c46c6bb576b26402c6c6d7bdf8c963a82b855e19bffd

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