Git Commit Assistant

AI-powered Git commit assistant that helps you write better commit messages using multiple AI services.

Features

• 🤖 Multiple AI services support (Gemini, GPT-4, Claude, Deepseek)
• 📝 Conventional commits format with emojis
• 🔍 Smart analysis of your changes
• 🎨 Beautiful CLI interface
• 🔒 Protected branch validation
• 🚀 Optional automatic push
• 🔐 Secure API key storage using system keyring
• 🎯 Project-specific configuration
• 🧠 Automatic project context detection

Installation

Via NPM (Recommended)

npm install -g git-commit-assistant

The installation will automatically create a Python virtual environment and install all dependencies.

Updating

To update to the latest version:

npm install -g git-commit-assistant@latest

Via Python (Alternative)

# Create virtual environment
python3 -m venv venv

# Activate virtual environment
# On Unix/macOS:
source venv/bin/activate
# On Windows:
.\venv\Scripts\activate

# Install package
pip3 install git-commit-assistant

Setup

1. Choose your preferred AI service and get the API key:

   • Google AI Studio for Gemini (default)
   • OpenAI for GPT-4
   • Anthropic for Claude
   • Deepseek for Deepseek

2. Configure your API key:

# Interactive configuration (recommended)
gcommit --configure

# Or set environment variables
export GEMINI_API_KEY='your-api-key'      # For Gemini
export OPENAI_API_KEY='your-api-key'      # For OpenAI
export ANTHROPIC_API_KEY='your-api-key'   # For Claude
export DEEPSEEK_API_KEY='your-api-key'    # For Deepseek

3. Select your AI service:

# Check current configuration
gcommit --list

# Use specific service for one commit
gcommit -s openai   # or gemini, claude, deepseek

# Set default service
export AI_SERVICE='openai'  # or gemini, claude, deepseek

Project Configuration

You can customize the commit assistant for specific projects by creating a .commitrc.json file in your project root:

{
  "scopes": ["frontend", "backend", "database", "auth", "api"],
  "commitTypes": [
    {
      "type": "feat",
      "description": "New feature"
    },
    {
      "type": "fix",
      "description": "Bug fix"
    }
  ],
  "breakingPatterns": ["BREAKING CHANGE:", "API:", "DEPRECATED:"],
  "conventionalCommits": true,
  "maxLineLength": 72,
  "requireScope": true,
  "requireDescription": true,
  "allowCustomTypes": false,
  "allowCustomScopes": true
}

The assistant will automatically:

• Detect your project's primary language
• Identify frameworks and tools used
• Adapt commit types and scopes to your project
• Follow your project's commit conventions
• Suggest relevant scopes based on your project structure

Usage

Instead of git commit, you can use either:

gcommit              # Short command (recommended)
git-commit-assistant # Full command

Available options:

gcommit -a          # Stage all changes
gcommit -p          # Push after commit
gcommit -f          # Skip confirmations
gcommit -s openai   # Use OpenAI service
gcommit -c          # Configure AI service and API key
gcommit -l          # Show current AI service configuration

# Combine options
gcommit -a -p       # Stage all changes and push
gcommit -a -p -f    # Stage all, push, and skip confirmations
gcommit -a -s claude # Stage all and use Claude

The assistant will:

1. Analyze your project structure
2. Show your staged/unstaged changes
3. Generate context-aware commit messages
4. Let you edit or accept the message
5. Create the commit (and push if requested)

Requirements

• Python 3.6+
• Node.js 14+ (for NPM installation)
• Git

License

MIT

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.