Automatically generate commit messages using ChatGPT.
npx commitgptor use -c for conventional commits format.
npx commitgpt -c- Sign up for an OpenAI account and log in to the OpenAI dashboard: https://beta.openai.com/signup
- Generate a new API key by clicking on the "API Keys" tab and then clicking on the "Create API Key" button.
- Copy the API key to your clipboard.
- Open a terminal or command prompt and set the environment variable with the API key using the following command (replace "YOUR_API_KEY" with the actual API key you copied in step 3):
export OPENAI_API_KEY="YOUR_API_KEY"- Verify that the environment variable has been set correctly by running the following command:
echo $OPENAI_API_KEYThis should print the value of the OPENAI_API_KEY environment variable, which should be the API key you set in step 4.
Note: The steps to set environment variables may differ based on your operating system. For more information, you can refer to the documentation for your specific operating system.
- 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.