Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nguyenvanduocit/ai-commit
CLI tool that use ChatGPT to generate commit message for your git repo.
https://github.com/nguyenvanduocit/ai-commit
ai-commit automa chatgpt cli git git-commit openai
Last synced: about 2 months ago
JSON representation
CLI tool that use ChatGPT to generate commit message for your git repo.
- Host: GitHub
- URL: https://github.com/nguyenvanduocit/ai-commit
- Owner: nguyenvanduocit
- License: mit
- Created: 2023-02-02T15:48:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-29T18:54:18.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T16:27:19.332Z (5 months ago)
- Topics: ai-commit, automa, chatgpt, cli, git, git-commit, openai
- Language: Go
- Homepage:
- Size: 1.93 MB
- Stars: 99
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.producthunt.com/posts/ai-commit-2)
[](https://youtu.be/7cVU3BuNpok)
[View Demo](https://youtu.be/7cVU3BuNpok)
# ai-commit
> No more headaches with commit messages.
AI-Commit is a command line tool that uses OpenAI's ChatGPT model to generate commit messages for your Git repositories. As a result, you can write meaningful commit messages without having to think about them.
## Prerequisites
To use AI-Commit, you need to obtain an API key from OpenAI and set it as the value of the `OPENAI_API_KEY` environment variable.
```
export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
Sometime, the ChatGPT's response is not good (too long, too short, not meaningful). In that case, you can try custom the system prompt by set the `AI_COMMIT_SYSTEM_PROMPT` environment variable:
```
export AI_COMMIT_SYSTEM_PROMPT="You are a GitCommitGPT-4, You will help user to write commit message, commit message should be short (less than 100 chars), clean and meaningful. Only response the message."
```
By default, ai-commit use model `gpt-3.5-turbo`. You can change it by set the `AI_COMMIT_MODEL` environment variable:
```
export AI_COMMIT_MODEL="gpt-3.5-turbo"
```
Note: Using AI-Commit will result in charges from OpenAI for API usage, so be sure to understand their pricing model before use.
## Install
There are two ways to install AI-Commit:
### Use go
```bash
go install github.com/nguyenvanduocit/ai-commit@latest
```
### Prebuilt binaries
You can download prebuilt binaries for Linux, macOS, and Windows from the [releases page](https://github.com/nguyenvanduocit/ai-commit/releases)
## Usage
1. Stage the changes you want to commit in Git.
2. Run `ai-commit` command.
3. The tool will generate a commit message and print it to the console.
4. Now you can chat with the AI to adjust the commit message. Press ctrl + c to stop.
5. Finally, select the type of commit.
### Auto commit, no interaction
When use `-a` flag, ai-commit will auto stage all changes then commit with generated message.
```bash
ai-commit -a
```
### Auto tag
When use `-t` flag, ai-commit will auto create tag based on the commit messages between the last tag and the HEAD.
```bash
ai-commit -t
```
### Auto push
When use `-p` flag, ai-commit will auto push to remote.
```bash
ai-commit -p
```
## Todo
- [ ] Auto split changes in to multiple commits.
- [x] Detect commit type.
- [x] Auto tags?
## License
AI-Commit is released under the MIT license. See LICENSE for more information.
## Contributing
Contributions are welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first.
[](https://twitter.com/duocdev)