@committools/aicommit

v1.0.3

Published

3 months ago

AI-powered git commit message generator with support for multiple AI providers

0High
0Medium
0Low

alex_sol

git commit ai claude openai gpt gemini conventional-commits commit-message cli

AICommit 🤖

AI-powered commit message generator with support for multiple AI providers. Generate professional commit messages in Conventional Commits format.

✨ Features

🎯 Multiple AI Providers: Claude (Anthropic), GPT-4 (OpenAI), Gemini (Google)
📝 Conventional Commits: Automatic formatting in standard format
⚡ Quick Setup: Configure once and use forever
🎨 Interactive: Edit in console or git editor
💾 Local Configuration: API keys stored securely
🚀 Fast: Generate commit messages in seconds

🚀 Quick Start

Global Installation

npm install -g @committools/aicommit

First-Time Setup

aicommit --setup

You'll see an interactive menu to configure:

Default AI provider selection
API keys input
Auto-commit behavior

Usage

# Stage your files
git add .

# Generate commit message
aicommit

# Or with specific provider
aicommit --provider openai

# Or with git editor
aicommit --editor

# Short alias
aic

📖 Detailed Usage

Commands

aicommit                     # Generate commit for staged changes
aicommit --provider claude   # Use Claude (for this run only)
aicommit --provider openai   # Use GPT-4 (for this run only)
aicommit --provider gemini   # Use Gemini (for this run only)
aicommit --set-provider openai  # Change default provider permanently
aicommit --branch main       # Compare with main branch
aicommit --editor            # Open in git editor
aicommit --setup             # Configure API keys
aicommit --config            # Show current configuration
aicommit --help              # Show help

# Short alias (all same options work)
aic
aic --set-provider claude

Getting API Keys

Claude (Anthropic) - Recommended ⭐

Go to https://console.anthropic.com/
Create account or sign in
Navigate to API Keys
Create new key
Cost: ~$3 per million tokens

OpenAI (GPT-4)

Go to https://platform.openai.com/
Create account
Navigate to API keys
Create new key
Cost: ~$10 per million tokens

Google Gemini - Free 🎉

Go to https://makersuite.google.com/app/apikey
Sign in with Google account
Create API key
Cost: Free up to 60 requests/minute

Example Output

$ git add .
$ aicommit

🤖 AICommit Generator

✓ Found changes in 3 file(s)
Files: src/auth.js, src/middleware.js, tests/auth.test.js

✓ Commit message generated!

============================================================
Generated Commit Message:
============================================================
feat(auth): Add JWT authentication system

Implement complete JWT-based authentication to replace the
legacy session-based approach. This improves scalability and
enables stateless authentication across distributed services.

- Add JWT token generation and validation middleware
- Implement refresh token rotation mechanism
- Create authentication endpoints (login, logout, refresh)
- Add password hashing with bcrypt
- Update user model with token-related fields
- Add comprehensive authentication tests
============================================================

? What would you like to do?
  ✓ Commit with this message
  ✏️  Edit in git editor
  📋 Copy to clipboard
❯ ❌ Cancel

⚙️ Configuration

Configuration file is stored at ~/.aicommit/config.json

{
  "defaultProvider": "claude",
  "apiKeys": {
    "anthropic": "sk-ant-...",
    "openai": "sk-...",
    "gemini": "..."
  },
  "autoCommit": false
}

Environment Variables (Alternative)

Instead of storing in config, you can use environment variables:

export ANTHROPIC_API_KEY="sk-ant-..."
export OPENAI_API_KEY="sk-..."
export GEMINI_API_KEY="..."

🎯 Conventional Commits Format

The tool generates commits in standard format:

<type>(<scope>): <subject>

<body>

<footer>

Types:

feat: New feature
fix: Bug fix
docs: Documentation changes
style: Code formatting (no logic change)
refactor: Code refactoring without functionality change
perf: Performance improvements
test: Adding/updating tests
chore: Build updates, config changes, etc.
ci: CI/CD changes

📊 Provider Comparison

| Provider | Quality | Speed | Cost | Token Limit | |----------|---------|-------|------|-------------| | Claude | ⭐⭐⭐⭐⭐ | Fast | $3/1M | 200K | | GPT-4 | ⭐⭐⭐⭐⭐ | Fast | $10/1M | 128K | | Gemini | ⭐⭐⭐⭐ | Fast | Free | 32K |

Recommendation: Claude for best quality at reasonable price, Gemini for free usage.

Project Structure

aicommit/
├── bin/
│   └── gca.js           # CLI entry point
├── lib/
│   ├── ai-providers.js  # AI provider implementations
│   ├── config.js        # Configuration management
│   └── git.js           # Git operations
├── index.js             # Main export
├── package.json
└── README.md

🛠️ Troubleshooting

Problem: "No changes found"

Solution: Make sure you have staged files:

git add <files>
# or
git add .

Problem: "API key not configured"

Solution: Run setup:

aicommit --setup

Or set environment variable:

export ANTHROPIC_API_KEY="your-key"

Problem: "Rate limit exceeded"

Solution:

For Gemini: Wait a minute (60 req/min limit)
For Claude/OpenAI: Check your plan and limits

Problem: Incorrect formatting on Windows

Solution: Set git line ending settings:

git config --global core.autocrlf true

💡 Tips

Use frequently: The more you use it, the better AI understands your style
Staged changes: Always git add before aicommit
Edit freely: Don't hesitate to edit generated messages
Scope detection: AI automatically determines scope from files (auth, api, ui, etc.)
Large diffs: For very large changes, split into multiple commits

🤝 Contributing

Contributions are welcome!

Fork the repository
Create feature branch (git checkout -b feature/amazing)
Commit changes (aicommit 😉)
Push to branch (git push origin feature/amazing)
Open Pull Request