Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markuswt/gpt-commit
Generate commit messages using ChatGPT
https://github.com/markuswt/gpt-commit
chatgpt commit git gpt-3 openai
Last synced: 2 months ago
JSON representation
Generate commit messages using ChatGPT
- Host: GitHub
- URL: https://github.com/markuswt/gpt-commit
- Owner: markuswt
- License: mit
- Created: 2023-01-31T03:41:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-03T08:35:43.000Z (over 1 year ago)
- Last Synced: 2024-08-02T01:25:22.594Z (6 months ago)
- Topics: chatgpt, commit, git, gpt-3, openai
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 271
- Watchers: 3
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ChatGPT-repositories - gpt-commit - Generate commit messages using ChatGPT (Openai)
README
# `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 [email protected]:markuswt/gpt-commit.git
```
Set the environment variable `OPENAI_API_KEY` to your [OpenAI API key](https://platform.openai.com/account/api-keys), e.g. by adding the following line to your `.bashrc`.
```
export OPENAI_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](https://platform.openai.com/docs) 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](https://openai.com/policies/terms-of-use) and [API data usage policies](https://openai.com/policies/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.