AI-generated Conventional Commit messages from your staged Git diff. Local (Ollama) or cloud (OpenAI).
Project description
gitmsg-ai
AI-generated Conventional Commit messages from your staged Git diff.
Works with local models via Ollama (free, private) or OpenAI (paid).
📦 Previously published as
commit-msg-ai. Both CLI commands (gitmsg-aiandcommit-msg-ai) work for backwards compatibility.
Features
- ✨ Conventional Commits —
feat,fix,docs,refactor, etc. - 🎨 Gitmoji support —
✨ feat:,🐛 fix:,📝 docs:with--emoji - 🎲 Interactive mode — generate 3 options, pick the best with
--interactive - 💾 Smart caching — re-running on the same diff is instant
- 📊 Amend support — regenerate message for last commit with
--amend - 🌍 Multi-language —
--lang ru,--lang en, 16+ languages - 🪝 Git hook — auto-generate on every
git commit - 🔌 Two providers — Ollama (local) or OpenAI (API)
Install
From PyPI (recommended)
pip install gitmsg-ai
From source
git clone https://github.com/Weretik18/commit-msg-ai.git
cd commit-msg-ai
pip install -e .
Then create a config:
mkdir -p ~/.commit-msg-ai
cp config.example.yaml ~/.commit-msg-ai/config.yaml
Quick start (Ollama, recommended)
Install Ollama
Pull a coding model: ollama pull qwen2.5-coder:7b
Edit ~/.commit-msg-ai/config.yaml to use that model
Stage changes and run:
git add .
gitmsg-ai
Usage
undefined
Default: generate one commit message
gitmsg-ai
With emoji
gitmsg-ai --emoji
Pick from 3 options
gitmsg-ai --interactive
In Russian
gitmsg-ai --lang ru
Regenerate for last commit (use with git commit --amend)
gitmsg-ai --amend
Skip cache (always call the model)
gitmsg-ai --no-cache
Subject line only, no body
gitmsg-ai --no-body
Pipe straight into git
gitmsg-ai | git commit -F -
## Git hook (automatic mode)
```bash
gitmsg-ai install-hook
Now every git commit will pre-fill the commit message editor with an AI-generated one.
To remove:
gitmsg-ai uninstall-hook
Commands
Command What it does
gitmsg-ai Generate a commit message
gitmsg-ai install-hook Install prepare-commit-msg hook
gitmsg-ai uninstall-hook Remove the hook
gitmsg-ai clear-cache Delete all cached messages
gitmsg-ai --version Show version
Config
~/.commit-msg-ai/config.yaml:
provider: ollama # or "openai"
ollama:
host: http://localhost:11434
model: qwen2.5-coder:7b
openai:
api_key: "" # or set OPENAI_API_KEY env var
model: gpt-4o-mini
options:
max_length: 72
include_body: true
language: en
Development
undefined
Clone and install in dev mode
git clone https://github.com/Weretik18/commit-msg-ai.git
cd commit-msg-ai
pip install -e ".[dev]"
Run tests
pytest tests/ -v
Lint
ruff check commit_msg_ai/ tests/
## License
MIT — see [LICENSE](LICENSE) for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gitmsg_ai-0.2.5.tar.gz.
File metadata
- Download URL: gitmsg_ai-0.2.5.tar.gz
- Upload date:
- Size: 14.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6fe1f5e1db09ac5cb1a5107f895f274adeb0709587f39c9c9a1d2b88b6b7fc6f
|
|
| MD5 |
de3c0abfe1d45cbfcdcbe4206b85e2fa
|
|
| BLAKE2b-256 |
15bcf5432ddbfcec1335437bd8491405423b1918d39f1dbbe5700024c5642767
|
Provenance
The following attestation bundles were made for gitmsg_ai-0.2.5.tar.gz:
Publisher:
publish.yml on Weretik18/commit-msg-ai
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gitmsg_ai-0.2.5.tar.gz -
Subject digest:
6fe1f5e1db09ac5cb1a5107f895f274adeb0709587f39c9c9a1d2b88b6b7fc6f - Sigstore transparency entry: 1687096558
- Sigstore integration time:
-
Permalink:
Weretik18/commit-msg-ai@d94df818614d6026f21070d129d29dbeff87f306 -
Branch / Tag:
refs/tags/v0.2.5 - Owner: https://github.com/Weretik18
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@d94df818614d6026f21070d129d29dbeff87f306 -
Trigger Event:
push
-
Statement type:
File details
Details for the file gitmsg_ai-0.2.5-py3-none-any.whl.
File metadata
- Download URL: gitmsg_ai-0.2.5-py3-none-any.whl
- Upload date:
- Size: 14.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2674c351cdcc5e60366ed76f6ef5a7b5c3d1045e36d43d9bd4ff258249910190
|
|
| MD5 |
92c0b735cc89f4068c4c6a9d457edaa3
|
|
| BLAKE2b-256 |
d61225c64700611a29edf5d2b2c069a898abc96e51533258d032de7026e5942e
|
Provenance
The following attestation bundles were made for gitmsg_ai-0.2.5-py3-none-any.whl:
Publisher:
publish.yml on Weretik18/commit-msg-ai
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gitmsg_ai-0.2.5-py3-none-any.whl -
Subject digest:
2674c351cdcc5e60366ed76f6ef5a7b5c3d1045e36d43d9bd4ff258249910190 - Sigstore transparency entry: 1687098000
- Sigstore integration time:
-
Permalink:
Weretik18/commit-msg-ai@d94df818614d6026f21070d129d29dbeff87f306 -
Branch / Tag:
refs/tags/v0.2.5 - Owner: https://github.com/Weretik18
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@d94df818614d6026f21070d129d29dbeff87f306 -
Trigger Event:
push
-
Statement type: