# Git Commit Helper [](https://github.com/newdee/git-commit-helper)
## Overview
Git Commit Helper is a practical tool that leverages large language models (LLMs) to analyze changes in a Git repository. It helps users generate meaningful commit messages, addressing the difficulties users may encounter when writing commit messages. At the same time, it provides a user - friendly command - line interaction experience.
## Preview
You can use the `git-commit-helper` command directly to generate meaningful commit messages. Additionally, you can also use it within `lazygit` to quickly submit commits. Here is a preview video of using `git-commit-helper` in `lazygit`.
[](https://asciinema.org/a/718306)
## Install
You can either download the corresponding package released in the `release` section or use the following command to install:
```
cargo install git-commit-helper
```
## Usage
This tool supports **either OpenAI or Ollama** as the language model provider.
**Configure only one provider at a time.**
### Environment Variables
- **For OpenAI**:
- `OPENAI_API_KEY` (**Required**)
- `OPENAI_BASE_URL` (*Optional*, defaults to OpenAI's official endpoint)
- **For Ollama**:
- `OLLAMA_BASE_URL` (*Optional*, defaults to `http://localhost:11434`)
### Example Command
Use this tool after running `git add`:
```
Usage: git-commit-helper [OPTIONS]
Options:
-p, --provider <PROVIDER> [default: openai]
-m, --model <MODEL> [default: gpt-4o]
--gpgsign
--gpgsignkey <GPGSIGNKEY> [default: ]
--max-token <MAX_TOKEN> [default: 2048]
-h, --help Print help
-V, --version Print version
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## 🙏 Support
If you find this project helpful, please consider giving it a ⭐️!