Skip to content

mdshzb04/vibecheck

 
 

Repository files navigation

vibecheck

A Cross-Platform Command-Line AI-tool for automating git commit messages by outsourcing them to LLMs. Supports multiple providers including OpenAI, Gemini, Anthropic, Groq, Grok, Kimi K2, Qwen, DeepSeek, Perplexity Sonar, and Ollama.

Installation

macOS/linux

curl -fsSL https://install.raashed.xyz | bash

windows

iwr https://install.raashed.xyz/install.ps1 -useb | iex

Important : Make sure to run the command as an administrator using Powershell.

macOS (brew)

brew tap rshdhere/vibecheck
brew install --cask vibecheck

Note : Direct install via brew install vibecheck is comming soon

The Ultimate One Liner

vibecheck commit

Note : Make sure you stage your files, right before you check that it passes the vibecheck ;)

Demonstration

full-demo-vibecheck

More Features

vibecheck dashboard

Dashboard : It keeps the tab of the commits you generated and money you saved with vibecheck

dashboard-cut

vibecheck models

Models : You can switch the models for better latency and accuracy all along

models

Supported Models

All models are selected for cost-efficiency and quality comparable to GPT-4o-mini:

Provider Model Cost-Efficiency Speed
OpenAI gpt-4o-mini High Fast
Gemini gemini-2.5-flash Very High Ultra-Fast
Anthropic claude-3.5-haiku High Fast
Groq llama-3.3-70b-versatile Very High Ultra
xAI grok-beta High Fast
Kimi moonshot-v1-auto Very High Ultra-Fast
Qwen qwen-turbo Very High Ultra-Fast
DeepSeek deepseek-chat Extremely High Ultra-Fast
Perplexity sonar High Fast
Ollama gpt-oss:20b Free (Local) Medium

Environment Variables

Set up your API keys as environment variables:

Skip: If you already have one of the API keys in your .env already, then it picks it up AUTOMATICALLY.

export OPENAI_API_KEY="your-openai-api-key"

export GEMINI_API_KEY="your-gemini-api-key"

export ANTHROPIC_API_KEY="your-anthropic-api-key"

export GROQ_API_KEY="your-groq-api-key"

export XAI_API_KEY="your-xai-api-key"

export MOONSHOT_API_KEY="your-moonshot-api-key"

export QWEN_API_KEY="your-qwen-api-key"

export DEEPSEEK_API_KEY="your-deepseek-api-key"

export PERPLEXITY_API_KEY="your-perplexity-api-key"

export OLLAMA_HOST="http://localhost:11434"

Usage For Productivity (Mini Docs)

vibecheck commit

vibecheck commit --provider openai    # GPT-4o-mini
vibecheck commit --provider gemini    # Gemini 2.5 Flash
vibecheck commit --provider anthropic # Claude 3.5 Haiku
vibecheck commit --provider groq      # Llama 3.3 70B
vibecheck commit --provider grok      # Grok Beta
vibecheck commit --provider kimi      # Kimi K2 (Moonshot-v1-auto)
vibecheck commit --provider qwen      # Qwen Turbo
vibecheck commit --provider deepseek  # DeepSeek Chat
vibecheck commit --provider perplexity # Perplexity Sonar (sonar)
vibecheck commit --provider ollama    # gpt-oss:20b (local)

vibecheck commit --prompt "make sure to use 02 emoji's in my commit message"

vibecheck commit --provider gemini --prompt "fixed bug in parser"

vibecheck --version
vibecheck --help

Upgrading

Keep vibecheck up to date with a single command:

vibecheck upgrade

Note : If vibecheck is installed in a protected directory like /usr/local/bin, the upgrade command will automatically re-run itself with sudo to complete the installation.

Configuration

Free API Keys : A quick walk through by a contributor, over how to actually get an API key

gemini.webm
perplexity.mp4

About

vibecheck is a lightweight, cross-platform command line AI-tool that automatically generates meaningful and consistent Git Commit Messages by analyzing your code changes — ship faster with vibecheck

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Go 92.1%
  • PowerShell 3.6%
  • Shell 3.5%
  • Makefile 0.8%