Skip to main content

A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes.

Project description

🤖 AI Commitizen Plugin

A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear,
concise, and conventional commit messages based on your staged git changes.

npm version

Need help building your AI tool? Connect with Adrian on X 🚀

Features

  • Analyzes your staged diffs using OpenAI GPT-4o
  • 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.)

Prerequisites

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

uv build

Upload to pypi.org

twine upload dist/*

Author

Adrian C (watadarkstar)

Credits

Generated using this template: https://github.com/commitizen-tools/commitizen_cz_template

📄 License

This project is licensed under the MIT License.
Feel free to use, modify, and distribute it as needed.


Ready to build your AI tool?

Star this repo • 💬 Contact Adrian to Build It

Built with ❤️ by Adrian


Keywords: react-native, react, parlant, ai, tool, commits, python, commitizen

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

cz_ai-0.7.6.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cz_ai-0.7.6-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file cz_ai-0.7.6.tar.gz.

File metadata

  • Download URL: cz_ai-0.7.6.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for cz_ai-0.7.6.tar.gz
Algorithm Hash digest
SHA256 407327946a046b7e7588591365d6c87b32fccf40f04e851ad7cca1e45c049c12
MD5 9bf2ff3ed21e9ca8ae5ec89115881359
BLAKE2b-256 a2f998863db6e02586d8b09e400d4e89ada28ffaf4a2658c48f229f02d9e74c7

See more details on using hashes here.

File details

Details for the file cz_ai-0.7.6-py3-none-any.whl.

File metadata

  • Download URL: cz_ai-0.7.6-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for cz_ai-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f16fa81e48dbc29101014d2672d4cb444b10d94a42fdf09bfe8591a800e0707c
MD5 b6eaeb2740dbe321b7118dda501ae03a
BLAKE2b-256 db48671bbdaec81033616b9de1cfa3b29aece691a6dae94535060c1cf95a6d24

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page