commitgpt4
v1.2.0
Published
Automatically generate commit messages using ChatGPT
Downloads
3
Readme
CommitGPT4
A Node.js module that allows users to generate commit message suggestions based on OpenAI's GPT API.
Usage
To use this module, simply run the following command:
commitgpt4
This will generate a list of commit message suggestions based on your Git index.
Installation
To install this module, run the following command:
npm install -g commitgpt4
Configuration
Before running the CommitGPT4 command, you will need to configure your OpenAI API key. You can do this by setting an environment variable called OPENAI_API_KEY to your API key.
Use the folowing command to set your environment variable :
Unix : export COMMITGPT4_OPENAI_API_KEY="<YOUR_OPENAI_API_KEY>"
Windows : set COMMITGPT4_OPENAI_API_KEY="<YOUR_OPENAI_API_KEY>"
Powershell : $env:COMMITGPT4_OPENAI_API_KEY="<YOUR_OPENAI_API_KEY>"
Alternatively, you can pass your API key directly to the command:
commitgpt4 --apiKey=<openai_key>
This will show a commit suggestions based on your git index.
License
This project is licensed under the MIT License. See the license here.