ℹ️ This project is primarily hosted on our self-managed server, with mirrored versions on CodeBerg and GitHub. For the most recent updates and full project details, please visit our main repository: https://code.apps.glenux.net/glenux/llm-commit-gen.

llm-commit-gen

LLM plugin for generating Git commit messages using an LLM.

Note: This project is a fork of the original GNtousakis/llm-commit repository, which appears to be unmaintained. This fork integrates all pending pull requests from the original project while adding new fixes and features.

Prerequisites & Dependencies

LLM must be installed (this plugin runs within LLM).
Python 3.7+ is recommended.

Installation

Install this plugin in the same environment as LLM.

llm install llm-commit-gen

For ease of use, it is also recommended to integrate llm-commit as a git alias. To do this, modify the ~/.gitconfig file and add a new line at the end of the [alias] section:

[alias]
    # ...
    llmcommitgen = !llm commit-gen --semantic --model 4o --max-tokens 1000

Usage

The plugin adds a new command, llm commit-gen. This command generates a commit message from your staged Git diff and then commits the changes.

For example, to generate and commit changes:

# Stage your changes first
git add .

# Generate and commit with an LLM-generated commit message
llm commit-gen

You can also customize options:

# Enforce a specific commit style
llm commit-gen --semantic
llm commit-gen --conventional

# Skip the confirmation prompt
llm commit-gen --yes

# Use a different LLM model, adjust max tokens, or change the temperature
llm commit-gen --model gpt-4 --max-tokens 150 --temperature 0.8

# Control diff truncation behavior
llm commit-gen --truncation-limit 2000  # Truncate diffs longer than 2000 characters
llm commit-gen --no-truncation         # Never truncate diffs (use with caution on large changes)

Configuration

To avoid repeating parameters on the command line, you can set defaults settings throught environment variables:

Environment variable	Description
`LLM_COMMIT_MODEL`	LLM model to use. Default: same as LLM
`LLM_COMMIT_MAX_TOKENS`	Max tokens. Default: 100
`LLM_COMMIT_TEMPERATURE`	Temperature. Default: 0.3
`LLM_COMMIT_TRUNCATION_LIMIT`	Character limit for diff truncation. Default: 4000
`LLM_COMMIT_NO_TRUNCATION`	Disable diff truncation. Can cause issues with large diffs. Default: False
`LLM_COMMIT_STYLE`	Enforce commit format (e.g., conventional, semantic). Default: none.
`LLM_COMMIT_HINT`	Hint message to guide the commit message generation. Default: none.

Example:

export LLM_COMMIT_STYLE=conventional
llm commit-gen

Development (Building from Source)

To set up this plugin locally, first check out the code. Then create a new virtual environment:

cd llm-commit-gen
python3 -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

python -m pytest

Contributors

Original author (before the fork): Grigoris Ntousakis (GNtousakis)
Current maintainer: Glenn Rolland (glenux)

License

This plugin is licensed under the terms of the MIT license.