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 (MVP)

From project root:

python3 -m venv .venv
source .venv/bin/activate
pip install -e .

After install, you can use the vibecheck command directly.

Configure

cp .env.example .env
# edit .env and set VIBECHECK_GITHUB_TOKEN

Usage

Single command mode:

vibecheck python buggy_sample.py

Interactive mode (tool waits in terminal):

vibecheck --shell

Then type commands like:

python buggy_sample.py
node buggy_advanced.js

Exit interactive mode with exit or quit.

Useful Flags

vibecheck --level beginner python buggy_sample.py
vibecheck --level advanced node buggy_advanced.js
vibecheck --print-raw-error python buggy_sample.py

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

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5d1b4df4813147b2482e1d8bcd4182361e2c9cfbbd29b6c632d2761be9493dd8
MD5 0c6de618306d2b6f1c91e135bfaa857f
BLAKE2b-256 f8bf9464c20b7ab3e851c850e7f2b4df3e262ea807c475cc2c218de55752d095

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vibecheck_error_assistant_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2483b29698432f5310fef07a5d502bceebbea2e541d1465d648fdc17655a8c78
MD5 7884238d5168040ee451002b96dd3e5f
BLAKE2b-256 85d7f53e38f0493af8bd55d79ff76519a069069c43ea990f760f41ebc6781d73

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