Professionalize your Git history with AI-generated Conventional Commits.
Stop writing "fixed stuff" and start writing commits that tell a story.
Commit-AI transforms raw, technical code changes into human-readable, professional documentation. By leveraging Groq's inference engine (Llama 3.1 8B), it acts as a bridge between your terminal and your project's history.
The tool reads your Git Diff to understand:
- Intent: Adding a feature or fixing a regression?
- Impact: What specific logic changed within the functions?
- Context: Automatically filters out noise like
package-lock.jsonornode_modules.
For Go Users:
go install github.com/NeelFrostrain/Commit-Ai-Go@latest
For Windows (Non-Go Users):
- Download the latest
commit-ai-installer.exefrom Releases. - Run the installer. It will automatically move the binary to your
AppDataand update yourPATH.
You don't need to manually create .env files.
- Visit Groq Console to get your key.
- Run
commit-aiin any terminal. - Paste your key when prompted. Commit-AI will save it to
~/.commit-ai-keyand your System Registry for global access.
| Feature | Description |
|---|---|
| 🧠 Deep Diff Analysis | Understands code logic, not just file metadata. |
| 📝 Conventional Style | Strictly follows the type: description standard. |
| 📊 Technical Reports | Generates a detailed bulleted summary for the commit body. |
| 🛡️ Global Config | Set your API key once, use it in any project folder. |
| 🚀 Fast | Powered by Groq/Llama-3.1 for near-instant results. |
| Flag | Short | Description |
|---|---|---|
--commit |
-c |
Performs the git commit after generating the message. |
--yes |
-y |
Skips the confirmation prompt (Auto-pilot). |
--version |
-v |
Displays version information. |
- Stage changes:
git add . - Review AI suggestion:
commit-ai - Commit with AI:
commit-ai -c
feat, fix, docs, style, refactor, chore.
- Local Keys: Your API key is stored locally on your machine.
- Diffs Only: Only the code diff of your staged files is sent to the AI.
MIT © Neel Frostrain