https://github.com/the-cafe/git-ai-commit
let AI write your commit messages
https://github.com/the-cafe/git-ai-commit
ai cli githook llms python
Last synced: about 1 year ago
JSON representation
let AI write your commit messages
- Host: GitHub
- URL: https://github.com/the-cafe/git-ai-commit
- Owner: the-cafe
- Created: 2024-08-03T22:12:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-22T02:55:54.000Z (about 1 year ago)
- Last Synced: 2025-04-22T22:09:32.004Z (about 1 year ago)
- Topics: ai, cli, githook, llms, python
- Language: Python
- Homepage: https://pypi.org/project/git-ai-commit/
- Size: 18.4 MB
- Stars: 66
- Watchers: 5
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🤖 `git-ai-commit`
Tl;DR
- AI that writes your commit messages.
- A CLI and git hook that summarizes your changes every time you run `git commit`.
- Integrates with the [`pre-commit`](https://pre-commit.com/) framework, working alongside all your git hooks.
## 📺 Usage
`git-ai-commit` currently support the following LLM providers...
- **Open AI**: `gpt-4o-mini`(default), `gpt-4`, `gpt-3.5`, and [more...](https://github.com/ming1in/ai-commit-msg/blob/a1e62be64c1f877bfa26c45d2d61508f94504ec0/ai_commit_msg/utils/models.py#L1)
- **Anthropic**: `claude-3-haiku`, `claude-3-sonnet`, `claude-3-opus`
- [Wiki: Setup Anthropic Model](./wiki/anthropic.md)
- **Local Ollama**: `llama3`, `mistral`, `phi-3`, `gemma`, and [more..](https://github.com/ming1in/ai-commit-msg/blob/a1e62be64c1f877bfa26c45d2d61508f94504ec0/ai_commit_msg/utils/models.py#L1)
- [Wiki: Using local Ollama LLM model](./wiki/ollama.md)
## 🚀 Getting Started
1. Install the `git-ai-commit` tool via pip
```bash
pip install git-ai-commit
git-ai-commit --version # verify installation
```
2. Start configuring your tool
```bash
git-ai-commit config --setup
```
3. Your done, happy committing! Check out our fun range of command, the LLM can even help you, just run...
```bash
git-ai-commit help-ai [question?]
# or get help the ol fashion way
git-ai-commit --help
```
## ⚡️ Quick Start: Setup Git Hook
To quickly setup your [`prepare-commit-msg`]() git hook, execute the command below.
Caution, this will override any existing `prepare-commit-msg` hooks you may have. To coordinate multiple git hook, check out the [`pre-commit`](https://pre-commit.com/) framework.
```bash
git-ai-commit hook --setup
```
That is all, your good to go! Now every time you run `git commit`, let AI present you with a commit message.
## 🪝 Integrate with `pre-commit` framework
`git-ai-commit` integrates easily with your other git hook using the `pre-commit` framework. Follow the instructions below to get set up.
1. Install the [`pre-commit`](https://pre-commit.com/) git hooks framework
```bash
brew install pre-commit
pre-commit --version
```
2. Create a `.pre-commit-config.yaml` files and add the following config.
```bash
touch .pre-commit-config.yaml
```
```yaml
# .pre-commit-config.yaml
default_install_hook_types:
# make sure you include `prepare-commit-msg` in `default_install_hook_types`
- prepare-commit-msg
repos:
- repo: https://github.com/the-cafe/git-ai-commit
rev: v1.0.9
hooks:
- id: git-ai-commit
```
3. Based on the config above, install your `pre-commit` hook scripts.
```bash
pre-commit install
```
4. Setup your OpenAI key, [see their docs for help](https://platform.openai.com/docs/quickstart).
```bash
git-ai-commit config --openai-key=...
```
## 🛠️ CLI Commands & Options
✨ `git-ai-commit config`
Display your current config settings. Option flags can be used to configure various settings in your configuration. For example...
```bash
git-ai-commit config
git-ai-commit config --openai-key=... --model=gpt-4o-mini
```
- `-k` `--openai-key`
Set or update the OpenAI API key to access their GPT models.
- `-a` `--anthropic-key`
Set or update the Anthropic API key to access their Claude models.
- `-m` `--model`
*default: "gpt-4o-mini"*
Select a model to power our tool from our supported provider. To use a [Ollama](./wiki/ollama.md) model, prefix `ollama/`.
- `-ou` `--ollama-url`
*default: ""*
Set the URL for interacting with your local Ollama models.
- `-s` `--setup`
Config your git hook, model, and API keys via the NUX flow.
- `-l` `--logger`
*default: false*
A toggle for enabling logs that are saved to a local file - `.git/ai_commit_message.log`. This was intended to be used as a local debug tool.
- `-r` `--reset`
Resets your entire config settings to the default state. This will reset all settings, including API keys and model.
- `-p` `--prefix`
Set a prefix for the generate commit messages.
- `-ml` `--max-length`
Set the character limit for the LLM response. In our testing, the greater the limit the more details are included in the commit messages.
---
🔎 `git-ai-commit summarize`
Get a quick summary of your local changes
```bash
git-ai-commit summarize
```
- `-u` `--unstaged`
Summarize your local *unstaged* changes.
- `-d` `--diff`
Provide a .diff file from the local file system to summarize
---
📌 `git-ai-commit help`, `-h`
Displays a list of available command and options to help you setup our tool.
```bash
git-ai-commit help # -h
```
---
🪝 `git-ai-commit hook`
Manage and setup `git-ai-commit` as a [`prepare-commit-msg`]() git hook.
```bash
git-ai-commit hook --setup
```
- `-s` `--setup`
Adds a git hook by generating a `.git/hooks/prepare-commit-msg` script in your git repo.
- `-sh` `--setup-husky`
Integrate our hook into your [husky git hooks](https://typicode.github.io/husky/) by generating a `.husky/prepare-commit-msg` script in your git repo.
- `-r` `--remove`
Removes the git hook.
- `-x` `--run`
Executes the custom logic for our git hook. This option was intended to only run from the [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) git hook.
## 🤝 Wanna Contribute?
Do you love our tool and wanna support us? Drop us a star 🌟
Have some feedback on what we could do better? [Create a issue](https://github.com/the-cafe/git-ai-commit/issues/new) we'll respond in 24hrs we promise 😄
Wanna contribute code and improve our product, check out our
[Local Development Wiki](./wiki/local_development.md) to get started.
Right now we're focused on
- Improving our prompting strategy to generate the best commit message possible
- Super charge our CLI to support broad developer use cases and build the best interface we can
- Build some tests
## 🎉 Fun Facts
- In this repository, every commit prefixed with `✨` was generated by AI.