GitVibe
Get Started

Documentation

Complete guide to using GitVibe for AI-powered commit messages and PR descriptions

Quick Start

1. Install GitVibe

npm install -g gitvibe

2. Initialize Configuration

gitvibe init

This will guide you through selecting an AI provider and entering your API key.

3. Generate Commit Message

git add .
gitvibe commit --apply

Commands

gitvibe init

Initialize GitVibe with AI provider setup

gitvibe init

What it does:

  • Guides you through provider selection (Groq, OpenAI, Google, Anthropic)
  • Lets you choose from available models
  • Securely stores your API key
  • Tests the configuration
  • Creates a default configuration file

Common Workflows

Quick Commit

git add .
gitvibe c --apply

Feature Branch to PR

git checkout -b feature/new
git add . && gitvibe c --apply
git push origin feature/new
gitvibe pr --open

Review Before Committing

git add src/
gitvibe commit --copy

Review and edit, then commit manually

Multi-Commit PR

gitvibe c --apply

Make more changes...

gitvibe c --apply
gitvibe pr --commits 2 --open

Configuration

Configuration File Location

~/.gitvibe/configs/<name>.yaml

Example Configuration

ai_provider: groq
model: llama3-8b-8192
temperature: 0.7
max_commit_tokens: 1024
max_pr_tokens: 65536
stream_output: true
commit_variations: 1

commit_prompt: |
  Generate a concise commit message following 
  conventional commits format.
  
  {diff}

pr_prompt: |
  Generate a professional PR title and description.
  
  {commits}

Supported AI Providers

  • Groq - Fast inference with Llama models (recommended for free tier)
  • OpenAI - GPT-4, GPT-3.5 models
  • Anthropic - Claude models
  • Google - Gemini models

Tips & Best Practices

Stage Related Changes

Group related files together for better commit messages

✓git add src/auth.ts src/auth.test.ts
✗git add src/auth.ts src/ui.css

Use Project-Specific Configs

Create different configs for different projects or teams

gitvibe config new work-project
gitvibe config new personal

Review Staged Changes

Always check what you're committing

git status
git diff --cached
gitvibe c

Adjust Temperature

Control AI creativity in your config

temperature: 0.3More focused
temperature: 1.0More creative

Need More Help?

Check out the complete CLI guide and GitHub repository for detailed documentation, examples, and troubleshooting.

GitHub Repository →Report Issues →Conventional Commits →