Easy Commit

AI-powered Git commit message generator

Installation

pip install easy-commit

Usage

Stage your changes

git add .

It is neccesary to first stage all your changes. This picks up the code diffs from the staged changes.

Save your default provider configuration

You can set the provider and api-key once when you first run it, after that you will be able to run it in any project or IDE.

easy-commit --provider groq --api-key your-api-key --save-config

Arguments:

• --diff-size : Maximum length of diff to analyze (default: 2048)
• --trunc-diff: Flag to include multiple diffs or truncate the diff (default: False)

Easy commit now supports bigger diffs, it splits those diffs into chunks and summarizes all the changes into a single message. use it when you have a lot of code changes, but be carefull as this might use a lot of tokens

• --commit-len: Maximum length of commit message (default: 100)
• --provider : API provider to use for LLM functionality (default: groq)
• --api-key : API key for the selected LLM provider
• --save-config : Flag to save the provided configuration of easier accesability later (default: False)

Check providers.yaml for the providers supported and their default models.

Examples

easy-commit

Yes! Thats actually all it takes. You will be shown the commit message, and prompted to press enter to perform the commit

With arguments

easy-commit --diff-size 1024 --commit-len 50 --provider groq --api-key your-api-key

Requirements

• Python 3.7+
• Groq API key