git-commit-summary

Git Commit Summary

Tired of writing git commit messages? This tool uses AI ✨ to automatically generate a concise commit summary for your staged changes.

Features

• Automatic Commit Summaries: Analyzes your staged changes and generates AI-slop high-quality commit messages.
• Interactive Confirmation: Prompts you to confirm the commit message before committing.
• Colorful Output: Provides a visually appealing and easy-to-read output in your terminal.
• Multiple LLM Providers: Supports Google Gemini, OpenAI, OpenRouter, and local Llama.cpp instances.
• Setup Wizard: Easy configuration with an interactive setup wizard.

Installation

go install github.com/rm-hull/git-commit-summary@latest

Ensure that the executable is on your $PATH. You can verify this by running git-commit-summary --version.

Setup

The easiest way to configure git-commit-summary is by using the built-in setup wizard:

git commit-summary --setup-wizard

This will guide you through selecting an LLM provider, choosing a model, and entering your API key. The configuration is stored in an XDG-compliant location (e.g., ~/.config/git-commit-summary/config.env).

Manual Configuration

If you prefer to configure the tool manually, you can create or edit the config.env file in your XDG config home directory:

• Linux: ~/.config/git-commit-summary/config.env
• MacOS: ~/Library/Application Support/git-commit-summary/config.env
• Windows: %USERPROFILE%\.config\git-commit-summary\config.env

You can also use a .env file in your git repository root for project-specific overrides.

Supported Providers

Local Llama.cpp Example

To point to a local llama.cpp service, use the following config:

LLM_PROVIDER="llama.cpp"
LLAMACPP_BASE_URL="http://localhost:8080/v1"
LLAMACPP_MODEL="Meta-Llama-3.1-8B-Instruct-Q4_K_M"

Usage

1. Stage your changes:

   git add <files>
   

2. Run the tool:

   git commit-summary
   

3. Confirm the commit: The tool will display the generated commit summary. Use the following shortcuts to interact with it:

   • CTRL+A: Accept and commit
   • CTRL+R: Reprompt & regenerate the commit message
   • CTRL+K: Clear the generated commit message
   • CTRL+P: Toggle preview mode
   • ESC: Abort

Flags

Git Alias

Add an alias to your ~/.gitconfig for faster access:

git config --global alias.cs commit-summary

Now you can just run git cs.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.