AI-powered Git commit message generator
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
easy-commit-0.2.1.tar.gz
(6.9 kB
view details)
File details
Details for the file easy-commit-0.2.1.tar.gz.
File metadata
- Download URL: easy-commit-0.2.1.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
704a5222ffc8339a78de9b2739e97c13faf347b10917d0b2b0600049ed5b4c0d
|
|
| MD5 |
14d37a7aec8e1dfed5afab86bb710445
|
|
| BLAKE2b-256 |
73957e78c0605d8fdbe6b6cbb53fba8ee6d20288df02d9aa1b33aef29a4fcfea
|