commitai
| Crates.io | commitai |
| lib.rs | commitai |
| version | 0.1.1 |
| source | src |
| created_at | 2024-11-16 09:43:47.532401 |
| updated_at | 2024-11-16 11:19:35.477261 |
| description | This is an ai commit message generator |
| homepage | |
| repository | |
| max_upload_size | |
| id | 1450268 |
| size | 67,975 |
Sidharth Babu (sidhuiwnl)
documentation
README
CommitAI
AI-powered git commit message generator using Google's Gemini API.
Installation
cargo install commitai
Setup
-
Get a Google API key from Google AI Studio
-
Create a config file:
Linux/macOS:
mkdir -p ~/.config/commitai
echo "GOOGLE_API_KEY=your_api_key_here" > ~/.config/commitai/config
Windows:
mkdir -p $env:APPDATA\commitai
echo "GOOGLE_API_KEY=your_api_key_here" > $env:APPDATA\commitai\config
Usage
- Stage your changes:
git add .
- Generate commit message:
commitai
- Choose what to do with the generated message:
y- Use the message and commite- Edit the message before committingn- Cancel without committing
Features
- Generates contextual commit messages based on staged changes
- Follows conventional commit format
- Supports message editing with your preferred editor
- Color-coded status messages
- Automatic retry with backoff
License
This project is licensed under the MIT License - see the LICENSE file for details.