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.2.tar.gz (7.4 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.2.tar.gz.

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 013048b5c9d8b907f54afa544e29e623fecb698c79d26ee6a378994025b9060e
MD5 61cc1e56bec2d9d5c133b590875a695d
BLAKE2b-256 92423e1e349b7878e9153d1169d0b29da5858134520fd1be64038846b1024ed6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f9ca9137ec377475967cd629ad908f6cfb399cd8899f17f0e6d75b6d6164d43b
MD5 2de92548063ded640a2a952ff0ca7209
BLAKE2b-256 4eb0942bf232128160b9dd49ce1d2014e14391d86038a41d82d04f014633982d

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