/chatgpt_commit_message_hook

Primary LanguagePythonMIT LicenseMIT

🤖 ChatGPT Commit Message Hook 🪝

Let ChatGPT write your commit messages.

Repository's starts Issues License
Latest commit GitHub repository size

ChatGPT will provide a suggestion for the commit message.

ChatGPT Commit Message Hook

What is it?

This is a hook for git that generates commit messages. It uses OpenAI's ChatGPT to generate commit messages.

How do I install it?

Setup

  1. Install the OpenAI API package (pip install openai).
  2. Create a file at $XDG_CONFIG_HOME/openaiapirc with your API keys. For example:
[openai]
secret_key = MY_SECRET_KEY
  1. Install the hook:
destination="/usr/share/git-core/templates/hooks/prepare-commit-msg"
sudo wget https://raw.githubusercontent.com/tom-doerr/chatgpt_commit_message_hook/main/prepare-commit-msg -O $destination
sudo chmod +x $destination

This will set up the hook for all new repositories. To add the hook to an existing repository, run git init.

How does it work?

The hook gets the current commit message, runs ChatGPT to generate a new commit message, and then replaces the current commit message with the generated message.