https://github.com/yankeexe/ai-gen-commit
✨Use AI to generate commit message for your staged changes.
https://github.com/yankeexe/ai-gen-commit
ai-commit chatgpt commit-generator gemini-api gemini-pro generative-ai- generative-ai-projects ollama ollama-app openai
Last synced: 3 months ago
JSON representation
✨Use AI to generate commit message for your staged changes.
- Host: GitHub
- URL: https://github.com/yankeexe/ai-gen-commit
- Owner: yankeexe
- License: mit
- Created: 2024-11-28T14:58:55.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T18:02:31.000Z (3 months ago)
- Last Synced: 2025-01-23T18:34:37.562Z (3 months ago)
- Topics: ai-commit, chatgpt, commit-generator, gemini-api, gemini-pro, generative-ai-, generative-ai-projects, ollama, ollama-app, openai
- Language: Python
- Homepage: https://pypi.org/project/ai-gen-commit
- Size: 22.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 🐙 AI Commit Generator
Use AI to generate commit message for your staged changes.
## ⚡️ Features
- Use local models (via Ollama) or remote models (with OpenAI API compatible providers like: `openai`, `groq`, `gemini`, `togetherai`, `deepseek`)
- Use your preferred AI model
- Regenerate commit messages until you find the perfect one
- Simple CLI interface with debug mode
## ⚡️ Install
```sh
pip install ai-gen-commit
```
## ✨ Generate Commit messages
In any git directory with staged changes, run:
```sh
aic
```
### 🔍 Run in debug mode
```sh
aic -d
```
### 🦙 Local Mode [Specify model to use]
```sh
aic -m
aic -m "llama3.2:3b"
# OR
export OLLAMA_MODEL="llama3.2:3b"
```
### 🛜 Remote Mode
To run in remote mode, export your API keys as:
```sh
export OPENAI_API_KEY=
```
Specify which remote provider to use:
```sh
export AI_COMMIT_PROVIDER="gemini" or "openai" or "togetherai" or "groq" or "deepseek"
```
then enable remote mode:
```sh
aic -r
```
Specify the model to use based on the provider's API key:
```sh
export AI_COMMIT_PROVIDER="openai"
aic -r -m "gpt-4o-2024-11-20"
# ---
export AI_COMMIT_PROVIDER="gemini"
aic -r -m "gemini-1.5-flash"
```
## Getting Help
```sh
aic -h
```
## 🔨 Development
### 👀 Prerequisites Local mode [default]
- [ollama](https://ollama.dev/download)
### 🚀 Setting up
```sh
make setup
```