Skip to content

Generate commit messages using ChatGPT

License

Notifications You must be signed in to change notification settings

markuswt/gpt-commit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gpt-commit

Generate commit messages using GPT-3. To use gpt-commit, simply invoke it whenever you'd use git commit. Git will prompt you to edit the generated commit message.

git add .
./gpt-commit.py

Getting Started

Install openai and clone gpt-commit.

pip3 install openai
git clone git@github.com:markuswt/gpt-commit.git

Set the environment variable OPENAI_API_KEY to your OpenAI API key, e.g. by adding the following line to your .bashrc.

export OPENAI_API_KEY=<YOUR API KEY>

Alternatively, you can set the openai.api_key variable in gpt-commit.py. You can also set openai.organization this way (optional).

Modify git commit (optional)

If you want git commit to automatically invoke gpt-commit, copy gpt-commit.py and prepare-commit-msg to the .git/hooks directory in any project where you want to modify git commit.

Privacy Disclaimer

gpt-commit uses the OpenAI API to generate commit messages. Both file names and contents from files that contain staged changes will be shared with OpenAI when using gpt-commit. OpenAI will process this data according to their terms of use and API data usage policies. On March 1st 2023 OpenAI pledged that by default, they would not use data submitted by customers via their API to train or improve their models, and that this data will be retained for a maximum of 30 days, after which it will be deleted.