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, ai, tool, commits, aicommits, 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.8.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.8-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cz_ai-0.7.8.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.8.tar.gz
Algorithm Hash digest
SHA256 1d027d0b0d5455fc88e2bbba9071c8fee4ed65d4fb694ad15ced6fa74add964e
MD5 3b93092e6db9e61aaffdf887a2addcfe
BLAKE2b-256 d2ddbdefe7c5a0aa629048948bf6b8e13b3ac7640b553b5747bd4d20c5f381ec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cz_ai-0.7.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4cdd4f00a958612360d54be61fdd9fef80e466db47a225b268d7b2bd4fffd934
MD5 edbfc82f872923f1e047549fed44533d
BLAKE2b-256 36aa67e9ef27c5a8dea6f4127294890ecd359bedc99369d8dac13431ad077600

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