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.3.tar.gz (7.7 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.3.tar.gz.

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.3.tar.gz
Algorithm Hash digest
SHA256 035d32a4c74fd1687d2322f28dca921b08f5439d1dcf1d68b73c817a84299c26
MD5 c3a72399d7af795473ff40638db77e03
BLAKE2b-256 54b3fc615fb7afb15c287b17d9ca019f180c5cba4a478383d919eb42f5411d1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 78362823cf1763a2936eaaceeaeb999dcda1f582cccbb45c3ef059c912b6e5c7
MD5 2f8995989e9ad7230cce30ec7be9aac0
BLAKE2b-256 51769ded67849e9fff8dead93ab50e965e2027b7e0e1cdeb1368cb55bf758f9a

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