Automatically generate commit messages using ChatGPT.

npx commitgpt

npm i
npm run build
npm link

# now you can use it
cd worksapce
commitgpt

https://platform.openai.com/account/api-keys

you can create .commitgpt.json and/or .commitgpt-template config files in your project root.

default:

{
  "model": "gpt-4-32k",
  "temperature": 0.7,
  "maxTokens": 2048,
  "locale": "english"
}

this file can be used to change the openai model and other parameters.

If you want to use Azure:

{
  "basePath": "https://<YOUR_RESOURCE_NAME>.openai.azure.com"
}

default:

suggest 10 commit messages based on the following diff:
{{diff}}
commit messages should:
 - follow conventional commits
 - message format should be: <type>[scope]: <description>

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.

• Runs git diff --cached
• Sends the diff to ChatGPT and asks it to suggest commit messages
• Shows suggestions to the user

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.