🤖 AI Commitizen Plugin
A Commitizen plugin that leverages OpenAI's models
and local LLMs from Ollama to automatically generate clear, concise, and
conventional commit messages based on your staged git changes.
Need help building your AI tool? Connect with Adrian on X 🚀
Features
- Analyzes your staged diffs using OpenAI GPT-4o or any LLM from Ollama
- Generates commit messages that follow the Conventional Commits specification
- Suggests high-quality messages instantly to save time
- Seamlessly integrates with existing Commitizen workflows
- Choose your preferred OpenAI model (gpt-4o-mini, gpt-4o, etc.) or locally installed Ollama model
Prerequisites
- Python 3.x
- Install commitizen
Install
pip install cz-ai
Usage
cz --name cz_ai commit
Terminal Alias
To make it persistent across sessions, add this line to your ~/.bashrc or
~/.bash_profile or /.config/fish/config.fish or ~/.zshrc (depending on your setup):
alias gai='cz --name cz_ai commit'
Development
Install the plugin locally:
pip install -e .
Then check that cz recognizes the plugin:
cz ls
It should appear as cz_ai
Then run this command to test it:
cz commit
Build
rm -rf dist/
uv build
Upload to pypi.org
twine upload dist/*
Author
Adrian C (watadarkstar)
License
This project is licensed under the MIT License.
Feel free to use, modify, and distribute it as needed.
Credits
Generated using this template: https://github.com/commitizen-tools/commitizen_cz_template
Github Contributors
Thanks to these awesome contributors and many more! 🧘
Ready to build your AI tool?
⭐ Star this repo • 💬 Contact Adrian to Build It
Built with ❤️ by Adrian
Keywords: react-native, react, ai, tool, commits, aicommits, python, commitizen
1 maintainer
Metadata
1 maintainer
Release files for cz-ai 0.8.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cz_ai-0.8.2.tar.gz | 6.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cz_ai-0.8.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 11.9 kB
Release files / cz_ai-0.8.2.tar.gz
| Download URL | cz_ai-0.8.2.tar.gz |
|---|---|
| Size | 6.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b071314ce885f366c1f62b7f966e21726622409dbf2ca73f64c2577965c3dbb6
|
|
BLAKE2b-256 checksum How to use checksums |
56626b5b274647102f2207d0845a1377debae61c4fd464df7b89072072143b2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.9
|
Release files / cz_ai-0.8.2-py3-none-any.whl
| Download URL | cz_ai-0.8.2-py3-none-any.whl |
|---|---|
| Size | 5.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
61c7070a07c7a9b2853f4332a1154e45535686866b6ef8df26ea6eb3071fb41b
|
|
BLAKE2b-256 checksum How to use checksums |
b7a21ff08ea1464b067e5912dbdd13b9f4855363d26284cbee4e6fabd365a1a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.9
|
