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.7.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.7-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cz_ai-0.7.7.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.7.tar.gz
Algorithm Hash digest
SHA256 99a60d5ba61634bff3663d578ea79792a81afe2a75f555bd6efd459487c6730d
MD5 00ca3fd45ddf052e2f6c838219923f33
BLAKE2b-256 d7f5afbf7840afee20b22cc114beb9fdf60688ade0bbab97bea4464ebb442588

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cz_ai-0.7.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 be49ec443b5c8517b1279f53c28bb9c1682cf3e44a0e483032214e5631a714b5
MD5 436482fd4241304d6eaa723549f14cd3
BLAKE2b-256 6e0b539aa987a1d2bf8532d1f4d3638c5e898b40f3b42c55563343ebe854e288

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