gitvibe
v1.4.0
Published
AI-powered CLI tool for generating commit messages and PR descriptions
Maintainers
Readme
GitVibe
AI-powered CLI tool for generating commit messages and PR descriptions. Streamline your Git workflow with intelligent, context-aware suggestions powered by leading AI models.
Features
- 🤖 AI-Powered Generation: Generate commit messages and PR descriptions using OpenAI, Google, Anthropic, or Groq
- 🎯 Conventional Commits: Follows conventional commit standards for consistent messaging
- 📋 Clipboard Integration: Easily copy generated content to clipboard
- 🔄 Multiple Variations: Get multiple suggestions and choose the best one
- 🚀 GitHub Integration: Create PRs directly with GitHub CLI
- ⚙️ Flexible Configuration: Multiple config profiles with custom prompts and settings
- 🎨 Interactive Mode: User-friendly prompts for easy setup and usage
Installation
Prerequisites
- Node.js 20.19.0+ (check with
node --version) - Git repository
- API key for your chosen AI provider
- github CLI (for PR)
Install via npm (Recommended)
npm install -g gitvibeInstall via pnpm
pnpm add -g gitvibe --ignore-scripts=falseQuick Start
You can use Groq free tier unless your git diff is really big.
Personally I use moonshotai/kimi-k2-instruct-0905 model. Hence it's defualt choice in the cli.
Initialize GitVibe:
gitvibe initThis will guide you through selecting an AI provider, model, and entering your API key.
Generate a commit message:
git add . gitvibe commitSelect from generated variations and commit directly or copy to clipboard.
Generate a PR description:
gitvibe prCreates a PR title and description from recent commits.
Commands
gitvibe init
Initialize GitVibe with AI provider setup. This interactive command will:
- Prompt you to select an AI provider (Groq, OpenAI, Google, or Anthropic)
- Choose a model from available options
- Enter your API key (securely stored)
- Test the configuration
- Create a default configuration file
gitvibe initgitvibe commit (alias: c)
Generate commit messages from staged changes.
Options:
--copy: Copy the selected message to clipboard--apply: Commit directly with the selected message--config <name>: Use a specific configuration
Examples:
# Interactive mode - select from variations
gitvibe commit
# Copy to clipboard
gitvibe commit --copy
# Commit directly
gitvibe commit --apply
# Use specific config
gitvibe commit --config my-configThe command analyzes your staged changes and generates multiple commit message variations following conventional commit format (e.g., feat: add user authentication).
gitvibe pr
Generate PR descriptions from recent commits.
Options:
--commits <n>: Number of recent commits to include (default: 1)--copy: Copy the PR content to clipboard--open: Create PR using GitHub CLI--config <name>: Use a specific configuration
Examples:
# Generate PR from last commit
gitvibe pr
# Include last 3 commits
gitvibe pr --commits 3
# Copy to clipboard
gitvibe pr --copy
# Create PR directly (requires GitHub CLI)
gitvibe pr --opengitvibe config
Manage configuration profiles.
gitvibe config new <name>
Create a new configuration file. Opens your default editor to customize:
- AI provider and model ( Groq with Kimi-k2 model is suggested)
- Custom prompts
- Temperature and token limits
- Output streaming preferences
gitvibe config new my-configgitvibe config list
List all available configurations with validity status.
gitvibe config listgitvibe config show [name]
Display configuration details. Shows default config if no name provided.
gitvibe config show
gitvibe config show my-configgitvibe config set-default <name>
Set the default configuration.
gitvibe config set-default my-configgitvibe create-config <name>
Create a new configuration interactively. This command guides you through selecting an AI provider, model, temperature, and API key, then tests the configuration and opens it in your editor for customization.
gitvibe create-config my-configExamples
Complete Workflow
# 1. Initialize (first time only)
gitvibe init
# 2. Stage your changes
git add .
# 3. Generate and commit
gitvibe commit --apply # gitvibe c
# 4. Push and create PR
git push origin feature-branch
gitvibe pr --openCustom Configuration
# Create custom config for different projects
gitvibe config new work-config
# Edit the config file that opens
# Modify prompts, temperature, etc.
# Use specific config
gitvibe commit --config work-configBatch Operations
# Generate PR from multiple commits
gitvibe pr --commits 5 --copy
# Quick commit without interaction
echo "quick fix" | git commit -F -
# Or use GitVibe for better messages
gitvibe commit --applyLicense
MIT License - see LICENSE file for details.
Inspiration
- https://github.com/KartikLabhshetwar/lazycommit
