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.

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

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

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 53fd04b51af12224617216cda486a774d514c67e6a00940c366d2f2cf3258d76
MD5 f33f6a3f910789738f90ddd0e386e652
BLAKE2b-256 e638bac6a2c3af5202fe6abbb3c1efcb47d1ceeece89df70ac7b57db313ad236

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b4506d0ef84ad38cf755d23bb21535f5d41a3681016d23c32fdfa0dc8c9f4cc
MD5 214c161ec062dafa88462aaab9cc38db
BLAKE2b-256 0c84e32a2b2d116d4fa597c5c6aeb09215e4271840eb378c5c93287249bae7e1

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