Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kpman/generate-git-commit-message
This script automates the creation of git commit messages based on staged changes using the OpenAI API.
https://github.com/kpman/generate-git-commit-message
Last synced: 15 days ago
JSON representation
This script automates the creation of git commit messages based on staged changes using the OpenAI API.
- Host: GitHub
- URL: https://github.com/kpman/generate-git-commit-message
- Owner: kpman
- Created: 2024-03-22T14:51:33.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-26T05:53:54.000Z (8 months ago)
- Last Synced: 2024-10-11T20:23:59.710Z (about 1 month ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Generate Git Commit Message
This script automates the generation of git commit messages using the OpenAI API.
It captures the staged changes (`git diff --staged`), uses a predefined template, and optionally incorporates the name of a subdirectory as part of the commit message.
The final commit message is then copied to the clipboard for easy use.
## Prerequisites
Before using this script, ensure that you have the `OPENAI_API_TOKEN` environment variable set in your session. This token is required for the script to authenticate with the OpenAI API and generate commit messages. You can set this variable in your shell's configuration file (e.g., `.bashrc`, `.zshrc`) like so:
```sh
export OPENAI_API_TOKEN='your_openai_api_token_here'
```
Replace `your_openai_api_token_here` with your actual OpenAI API token.
## Installation
To install this script globally using `yarn`, follow these steps:
1. Clone the repository to your local machine.
2. Navigate to the directory containing the script.
3. Run the following command to install the script globally:
```sh
yarn global add "file:$PWD"
```
## Usage
After installation, you can run the script from any git repository by executing:
```sh
ggcm
```
or
```sh
generate-git-commit-message
```
Ensure you have staged changes (`git add`) before running the script. The script will generate a commit message based on your staged changes and the template provided, then copy this message to your clipboard. You can then use `git commit` and paste the message to commit your changes.
## License
This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).
