https://github.com/romanhotsiy/commitgpt
Automatically generate commit messages using ChatGPT
https://github.com/romanhotsiy/commitgpt
Last synced: 4 days ago
JSON representation
Automatically generate commit messages using ChatGPT
- Host: GitHub
- URL: https://github.com/romanhotsiy/commitgpt
- Owner: RomanHotsiy
- Created: 2022-12-04T17:50:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T03:53:12.000Z (9 months ago)
- Last Synced: 2025-04-03T15:07:33.726Z (12 days ago)
- Language: TypeScript
- Size: 26.4 KB
- Stars: 1,591
- Watchers: 6
- Forks: 94
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ChatGPT-repositories - commitgpt - Automatically generate commit messages using ChatGPT (Others)
README
# commitgpt
Automatically generate commit messages using ChatGPT.
## How to use?
```bash
npx commitgpt
```
### Get OpenAI api key
https://platform.openai.com/account/api-keys
### Configuration (Optional)
you can create `.commitgpt.json` and/or `.commitgpt-template` config files in your project root.
#### `.commitgpt.json` file
default:
```json
{
"model": "text-davinci-003",
"temperature": 0.5,
"maxTokens": 2048,
}
```
this file can be used to change the openai model and other parameters.
### `.commitgpt-template` file
default:
```
suggest 10 commit messages based on the following diff:
{{diff}}
commit messages should:
- follow conventional commits
- message format should be: [scope]:
examples:
- fix(authentication): add password regex pattern
- feat(storage): add new test cases
```
this file can be used to change the template used to generate the prompt request. you can modify the template to fit your needs.
## How it works
- Runs `git diff --cached`
- Sends the diff to ChatGPT and asks it to suggest commit messages
- Shows suggestions to the user
## Credits
Some code and approaches were inspired by the awesome projects below:
- https://github.com/acheong08/ChatGPT
- https://github.com/transitive-bullshit/chatgpt-api
- https://github.com/wong2/chat-gpt-google-extension
----
Do you need API docs? Check out [Redocly](https://redocly.com).