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.7.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.7.tar.gz.

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.7.tar.gz
Algorithm Hash digest
SHA256 8c9f336bb229379abf751e1b7b6327a8396d44d736b742e28df97636ef79e4fb
MD5 189d2ed358a75e16db918e0d866ab4e7
BLAKE2b-256 9ec7cf48af87076f743da1f64d80521583ffb14a06a2de8e7a9e6c1a547b868c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 dd4ee08a904ecd0839a070db9eb637e07e0f5e2d2de49127eb1ff7c31e4e00c6
MD5 9a1a0d9489d75a8af520b1af4df23715
BLAKE2b-256 4ef5bcc4a07877ccc46427d2985b88674b8c022512c9a55baeb96aed268a8a75

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