# 🤖 Smart Commits AI - Universal Git Commit Generator
[](https://badge.fury.io/py/smart-commits-ai)
[](https://www.npmjs.com/package/smart-commits-ai)
[](https://hub.docker.com/r/joshi/smart-commits-ai)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/smart-commits-ai)
**AI-powered commit messages for ANY project - React, Flutter, Go, Python, and more!**
> Transform your Git workflow with AI that understands your code changes and generates perfect conventional commit messages. Works with **any programming language** and **any project type**.
This tool works as a **Git pre-commit hook** that analyzes your staged changes and generates professional commit messages using AI APIs (Groq, OpenRouter, Cohere).
---
## 🚀 Quick Start (2 minutes)
## 🚀 Universal Installation (Works with ANY Project)
### **Method 1: One-Line Install (Recommended)**
```bash
# Universal installer - works on macOS, Linux, Windows
curl -fsSL https://raw.githubusercontent.com/Joshi-e8/ai-commit-generator/main/install.sh | bash
```
### **Method 2: NPM (Perfect for JavaScript/React/Next.js)**
```bash
# Install via NPM (no Python knowledge required)
npm install -g smart-commits-ai
# Or use without global install
npx smart-commits-ai install
```
### **Method 3: Docker (Zero Dependencies)**
```bash
# Works everywhere, no local setup needed
docker run --rm -v $(pwd):/workspace joshi/smart-commits-ai install
```
### **Method 4: Python Package (Traditional)**
```bash
# For Python developers
pip install smart-commits-ai
```
## 📊 Choose Your Installation Method
| Method | Best For | Setup Time | Dependencies |
|--------|----------|------------|--------------|
| **One-Line Script** | Any team | 30 seconds | Auto-detected |
| **NPM Package** | JS/React/Node teams | 15 seconds | Node.js |
| **Docker** | DevOps/Containerized | 20 seconds | Docker only |
| **Python Package** | Python developers | 10 seconds | Python 3.8+ |
## ⚡ Quick Setup (2 Minutes)
### **Step 1: Get Free API Key**
Choose your preferred AI provider:
- **🚀 Groq** (Recommended - Free): https://console.groq.com/keys
- **🎯 OpenRouter** (Premium models): https://openrouter.ai/keys
- **🏢 Cohere** (Enterprise): https://dashboard.cohere.ai/api-keys
### **Step 2: Setup in Your Project**
```bash
# Navigate to ANY Git repository (React, Flutter, Go, Python, etc.)
cd your-awesome-project
# Install Git hook
smart-commits-ai install
# Add your API key
echo "GROQ_API_KEY=your_key_here" >> .env
```
### **Step 3: Start Using AI Commits**
```bash
# Normal Git workflow - AI handles the message!
git add src/components/Button.js
git commit # ✨ AI generates: "feat(ui): add Button component with hover effects"
```
**That's it! Every `git commit` now uses AI.** 🎉
## 🌍 Works with ANY Project Type
### **React/Next.js Projects**
```bash
# Install via NPM (feels native to JS developers)
npm install smart-commits-ai
npx smart-commits-ai install
# Example AI-generated commits:
# feat(components): add responsive navigation bar with mobile menu
# fix(api): resolve authentication token refresh issue
# style(ui): update button hover animations and color scheme
```
### **Flutter/Mobile Projects**
```bash
# One-line install
curl -fsSL https://raw.githubusercontent.com/Joshi-e8/ai-commit-generator/main/install.sh | bash
# Example AI-generated commits:
# feat(widgets): implement custom date picker with theme support
# fix(navigation): resolve back button behavior on Android
# perf(images): optimize asset loading and caching strategy
```
### **Backend Projects (Go, Rust, Java, etc.)**
```bash
# Docker approach (no dependencies)
docker run --rm -v $(pwd):/workspace joshi/smart-commits-ai install
# Example AI-generated commits:
# feat(api): add user authentication middleware with JWT
# fix(db): resolve connection pool timeout issues
# refactor(handlers): improve error handling and logging
```
### **Any Git Repository**
```bash
# Universal installer
bash <(curl -fsSL https://raw.githubusercontent.com/Joshi-e8/ai-commit-generator/main/install.sh)
# Works with: Python, C++, C#, PHP, Ruby, Swift, Kotlin, and more!
```
---
---
## ✨ Features
- **🌍 Universal**: Works with ANY programming language and project type
- **🤖 AI-Powered**: Uses Groq, OpenRouter, or Cohere APIs
- **📝 Conventional Commits**: Automatic `type(scope): description` format
- **⚡ Fast**: < 2 second response time with Groq
- **📦 Multiple Install Methods**: NPM, Docker, Python, or standalone
- **🔧 Configurable**: Customize prompts, models, and scopes
- **🛡️ Secure**: Only staged changes sent to AI, no data storage
- **🔄 Fallback**: Works even if AI fails
- **🎯 Team-Friendly**: No Python knowledge required for team adoption
- **🧪 Testable**: Comprehensive test suite and type hints
- **🎨 Rich CLI**: Beautiful command-line interface with colors
---
## 🎯 Real-World Examples
### **React Component Changes**
```bash
# Your changes: Added a new Button component with TypeScript
git add src/components/Button.tsx
git commit
# 🤖 AI generates: "feat(components): add Button component with TypeScript and hover animations"
```
### **Flutter Widget Updates**
```bash
# Your changes: Fixed navigation issue on Android
git add lib/screens/home_screen.dart
git commit
# 🤖 AI generates: "fix(navigation): resolve back button behavior on Android devices"
```
### **API Endpoint Development**
```bash
# Your changes: Added user authentication middleware
git add src/middleware/auth.go
git commit
# 🤖 AI generates: "feat(auth): implement JWT middleware with role-based access control"
```
### **Database Schema Updates**
```bash
# Your changes: Added indexes for better performance
git add migrations/add_user_indexes.sql
git commit
# 🤖 AI generates: "perf(db): add indexes on user table for faster queries"
```
## 🏢 Team Adoption
### **For JavaScript/TypeScript Teams**
```json
{
"devDependencies": {
"smart-commits-ai": "^1.0.4"
},
"scripts": {
"postinstall": "smart-commits-ai install",
"commit": "git commit"
}
}
```
### **For Any Team (Docker)**
```bash
# Add to team setup docs
echo 'alias smart-commits="docker run --rm -v $(pwd):/workspace joshi/smart-commits-ai"' >> ~/.bashrc
```
### **For CI/CD Pipelines**
```yaml
# .github/workflows/commits.yml
- uses: joshi-e8/smart-commits-ai-action@v1
with:
api_key: ${{ secrets.GROQ_API_KEY }}
```
---
## 📁 Project Structure
```
ai-commit-generator/
├── README.md # This file
├── TEAM_SETUP_GUIDE.md # Detailed team documentation
├── pyproject.toml # Python package configuration
├── src/
│ └── ai_commit_generator/
│ ├── __init__.py # Package initialization
│ ├── cli.py # Command-line interface
│ ├── core.py # Main commit generation logic
│ ├── config.py # Configuration management
│ ├── api_clients.py # AI API clients
│ └── git_hook.py # Git hook management
├── templates/
│ ├── .commitgen.yml # Configuration template
│ └── .env.example # Environment template
├── tests/ # Test suite
├── examples/ # Usage examples
└── legacy/ # Original bash scripts
├── install_hook.sh # Legacy installer
└── hooks/
└── prepare-commit-msg # Legacy hook script
```
---
## 🖥️ CLI Commands
### Install Hook
```bash
# Install Git hook in current repository
smart-commits-ai install
# Install with configuration files
smart-commits-ai install --config
# Force overwrite existing hook
smart-commits-ai install --force
```
### Manage Installation
```bash
# Check installation status
smart-commits-ai status
# Test with current staged changes
smart-commits-ai test
# Uninstall hook
smart-commits-ai uninstall
```
### Generate Messages
```bash
# Generate message for staged changes
smart-commits-ai generate
# Generate without writing to file (dry run)
smart-commits-ai generate --dry-run
# Generate and save to specific file
smart-commits-ai generate --output commit-msg.txt
```
### Configuration
```bash
# Show current configuration
smart-commits-ai config --show
# Validate configuration
smart-commits-ai config --validate
```
---
## 🔧 Configuration
### Basic Setup (`.env`)
```bash
# Choose one provider
GROQ_API_KEY=gsk_your_key_here
# OPENROUTER_API_KEY=sk-or-your_key_here
# COHERE_API_KEY=your_cohere_key_here
```
### Advanced Setup (`.commitgen.yml`)
```yaml
api:
provider: groq
commit:
max_chars: 72
types: [feat, fix, docs, style, refactor, test, chore]
scopes: [api, ui, auth, db, config]
prompt:
template: |
Generate a conventional commit message for:
{{diff}}
```
---
## 🏢 Team Deployment
### Option 1: Shared Network Drive
```bash
# Copy to shared location
cp -r ai-commit-generator /shared/tools/
# Team members install from shared location
/shared/tools/ai-commit-generator/install_hook.sh
```
### Option 2: Internal Git Repository
```bash
# Create internal repo
git init ai-commit-generator
git add .
git commit -m "feat: add AI commit message generator"
git remote add origin https://github.com/your-org/ai-commit-generator.git
git push -u origin main
# Team members clone and install
git clone https://github.com/your-org/ai-commit-generator.git
cd your-project
../ai-commit-generator/install_hook.sh
```
### Option 3: Package Distribution
```bash
# Create distributable package
tar -czf ai-commit-generator.tar.gz ai-commit-generator/
# Team members download and extract
curl -sSL https://your-server/ai-commit-generator.tar.gz | tar -xz
./ai-commit-generator/install_hook.sh
```
---
## 🛠️ Advanced Usage
### Custom Prompts
```yaml
prompt:
template: |
You are a senior developer. Generate a commit message for:
{{diff}}
Requirements:
- Use conventional commits
- Be specific about business impact
- Maximum {{max_chars}} characters
```
### Multiple Models
```bash
# Fast and efficient
GROQ_MODEL=llama3-8b-8192
# More detailed
GROQ_MODEL=llama3-70b-8192
# Creative
GROQ_MODEL=mixtral-8x7b-32768
```
### Debug Mode
```bash
DEBUG_ENABLED=true
tail -f .commitgen.log
```
---
## 🚨 Troubleshooting
| Issue | Solution |
|-------|----------|
| "API key not found" | Check `.env` file, ensure correct variable is set |
| "jq: command not found" | Install jq: `brew install jq` or `apt install jq` |
| "Rate limit exceeded" | Wait 1 minute or switch to different provider |
| "Hook not working" | Reinstall: `./install_hook.sh` |
---
## 📊 Provider Comparison
| Provider | Speed | Cost | Models | Best For |
|----------|-------|------|--------|----------|
| **Groq** | ⚡ Very Fast | 🆓 Free | Llama 3, Mixtral | Teams, Daily Use |
| **OpenRouter** | 🐌 Medium | 💰 Paid | Claude, GPT-4 | Premium Quality |
| **Cohere** | ⚖️ Fast | 🆓 Free Tier | Command-R | Enterprise |
---
## 🤝 Contributing
1. Fork the repository
2. Create feature branch: `git checkout -b feature/amazing-feature`
3. Commit changes: `git commit -m 'feat: add amazing feature'`
4. Push to branch: `git push origin feature/amazing-feature`
5. Open Pull Request
---
## 📄 License
MIT License - see [LICENSE](LICENSE) file for details.
---
## 🙏 Acknowledgments
- [Conventional Commits](https://www.conventionalcommits.org/) specification
- [Groq](https://groq.com/) for fast AI inference
- [OpenRouter](https://openrouter.ai/) for model diversity
- [Cohere](https://cohere.ai/) for enterprise AI
## 🎉 Success Stories
> **"We migrated our entire React team (12 developers) to Smart Commits AI in one day. Now our commit history is consistent and descriptive!"**
> — Frontend Team Lead
> **"Works perfectly with our Flutter CI/CD pipeline. No Python knowledge required for the mobile team."**
> — Mobile Developer
> **"The Docker approach was perfect for our polyglot microservices architecture."**
> — DevOps Engineer
## 📊 Why Teams Choose Smart Commits AI
| Team Type | Traditional Approach | With Smart Commits AI |
|-----------|---------------------|----------------------|
| **React/Next.js** | Inconsistent messages | Professional conventional commits |
| **Flutter/Mobile** | "fix", "update" messages | Descriptive widget/feature commits |
| **Backend APIs** | Generic descriptions | Specific endpoint/middleware commits |
| **Full-Stack** | Mixed commit styles | Unified team standards |
## 🔗 Links
- **📦 PyPI Package**: https://pypi.org/project/smart-commits-ai/
- **📦 NPM Package**: https://www.npmjs.com/package/smart-commits-ai
- **🐳 Docker Hub**: https://hub.docker.com/r/joshi/smart-commits-ai
- **📖 Universal Installation Guide**: [UNIVERSAL_INSTALLATION.md](UNIVERSAL_INSTALLATION.md)
- **🏢 Team Setup Guide**: [TEAM_SETUP_GUIDE.md](TEAM_SETUP_GUIDE.md)
---
**Transform ANY team's commit messages today! 🚀**
*Works with React, Flutter, Go, Python, Java, C++, and every other language.*
Raw data
{
"_id": null,
"home_page": null,
"name": "smart-commits-ai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "git, commit, ai, conventional-commits, automation, groq, openrouter, cohere, llama, claude, gpt, developer-tools, productivity, git-hooks, commit-messages, machine-learning, natural-language-processing, cli",
"author": null,
"author_email": "Joshi <joshi@nuox.io>",
"download_url": "https://files.pythonhosted.org/packages/c4/7d/1b7863dc01b6182588985982de90c791fb0a260fb9022e88eac8d704af8c/smart_commits_ai-1.1.0.tar.gz",
"platform": null,
"description": "# \ud83e\udd16 Smart Commits AI - Universal Git Commit Generator\n\n[](https://badge.fury.io/py/smart-commits-ai)\n[](https://www.npmjs.com/package/smart-commits-ai)\n[](https://hub.docker.com/r/joshi/smart-commits-ai)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/smart-commits-ai)\n\n**AI-powered commit messages for ANY project - React, Flutter, Go, Python, and more!**\n\n> Transform your Git workflow with AI that understands your code changes and generates perfect conventional commit messages. Works with **any programming language** and **any project type**.\n\nThis tool works as a **Git pre-commit hook** that analyzes your staged changes and generates professional commit messages using AI APIs (Groq, OpenRouter, Cohere).\n\n---\n\n## \ud83d\ude80 Quick Start (2 minutes)\n\n## \ud83d\ude80 Universal Installation (Works with ANY Project)\n\n### **Method 1: One-Line Install (Recommended)**\n```bash\n# Universal installer - works on macOS, Linux, Windows\ncurl -fsSL https://raw.githubusercontent.com/Joshi-e8/ai-commit-generator/main/install.sh | bash\n```\n\n### **Method 2: NPM (Perfect for JavaScript/React/Next.js)**\n```bash\n# Install via NPM (no Python knowledge required)\nnpm install -g smart-commits-ai\n\n# Or use without global install\nnpx smart-commits-ai install\n```\n\n### **Method 3: Docker (Zero Dependencies)**\n```bash\n# Works everywhere, no local setup needed\ndocker run --rm -v $(pwd):/workspace joshi/smart-commits-ai install\n```\n\n### **Method 4: Python Package (Traditional)**\n```bash\n# For Python developers\npip install smart-commits-ai\n```\n\n## \ud83d\udcca Choose Your Installation Method\n\n| Method | Best For | Setup Time | Dependencies |\n|--------|----------|------------|--------------|\n| **One-Line Script** | Any team | 30 seconds | Auto-detected |\n| **NPM Package** | JS/React/Node teams | 15 seconds | Node.js |\n| **Docker** | DevOps/Containerized | 20 seconds | Docker only |\n| **Python Package** | Python developers | 10 seconds | Python 3.8+ |\n\n## \u26a1 Quick Setup (2 Minutes)\n\n### **Step 1: Get Free API Key**\nChoose your preferred AI provider:\n\n- **\ud83d\ude80 Groq** (Recommended - Free): https://console.groq.com/keys\n- **\ud83c\udfaf OpenRouter** (Premium models): https://openrouter.ai/keys\n- **\ud83c\udfe2 Cohere** (Enterprise): https://dashboard.cohere.ai/api-keys\n\n### **Step 2: Setup in Your Project**\n```bash\n# Navigate to ANY Git repository (React, Flutter, Go, Python, etc.)\ncd your-awesome-project\n\n# Install Git hook\nsmart-commits-ai install\n\n# Add your API key\necho \"GROQ_API_KEY=your_key_here\" >> .env\n```\n\n### **Step 3: Start Using AI Commits**\n```bash\n# Normal Git workflow - AI handles the message!\ngit add src/components/Button.js\ngit commit # \u2728 AI generates: \"feat(ui): add Button component with hover effects\"\n```\n\n**That's it! Every `git commit` now uses AI.** \ud83c\udf89\n\n## \ud83c\udf0d Works with ANY Project Type\n\n### **React/Next.js Projects**\n```bash\n# Install via NPM (feels native to JS developers)\nnpm install smart-commits-ai\nnpx smart-commits-ai install\n\n# Example AI-generated commits:\n# feat(components): add responsive navigation bar with mobile menu\n# fix(api): resolve authentication token refresh issue\n# style(ui): update button hover animations and color scheme\n```\n\n### **Flutter/Mobile Projects**\n```bash\n# One-line install\ncurl -fsSL https://raw.githubusercontent.com/Joshi-e8/ai-commit-generator/main/install.sh | bash\n\n# Example AI-generated commits:\n# feat(widgets): implement custom date picker with theme support\n# fix(navigation): resolve back button behavior on Android\n# perf(images): optimize asset loading and caching strategy\n```\n\n### **Backend Projects (Go, Rust, Java, etc.)**\n```bash\n# Docker approach (no dependencies)\ndocker run --rm -v $(pwd):/workspace joshi/smart-commits-ai install\n\n# Example AI-generated commits:\n# feat(api): add user authentication middleware with JWT\n# fix(db): resolve connection pool timeout issues\n# refactor(handlers): improve error handling and logging\n```\n\n### **Any Git Repository**\n```bash\n# Universal installer\nbash <(curl -fsSL https://raw.githubusercontent.com/Joshi-e8/ai-commit-generator/main/install.sh)\n\n# Works with: Python, C++, C#, PHP, Ruby, Swift, Kotlin, and more!\n```\n\n---\n\n---\n\n## \u2728 Features\n\n- **\ud83c\udf0d Universal**: Works with ANY programming language and project type\n- **\ud83e\udd16 AI-Powered**: Uses Groq, OpenRouter, or Cohere APIs\n- **\ud83d\udcdd Conventional Commits**: Automatic `type(scope): description` format\n- **\u26a1 Fast**: < 2 second response time with Groq\n- **\ud83d\udce6 Multiple Install Methods**: NPM, Docker, Python, or standalone\n- **\ud83d\udd27 Configurable**: Customize prompts, models, and scopes\n- **\ud83d\udee1\ufe0f Secure**: Only staged changes sent to AI, no data storage\n- **\ud83d\udd04 Fallback**: Works even if AI fails\n- **\ud83c\udfaf Team-Friendly**: No Python knowledge required for team adoption\n- **\ud83e\uddea Testable**: Comprehensive test suite and type hints\n- **\ud83c\udfa8 Rich CLI**: Beautiful command-line interface with colors\n\n---\n\n## \ud83c\udfaf Real-World Examples\n\n### **React Component Changes**\n```bash\n# Your changes: Added a new Button component with TypeScript\ngit add src/components/Button.tsx\ngit commit\n# \ud83e\udd16 AI generates: \"feat(components): add Button component with TypeScript and hover animations\"\n```\n\n### **Flutter Widget Updates**\n```bash\n# Your changes: Fixed navigation issue on Android\ngit add lib/screens/home_screen.dart\ngit commit\n# \ud83e\udd16 AI generates: \"fix(navigation): resolve back button behavior on Android devices\"\n```\n\n### **API Endpoint Development**\n```bash\n# Your changes: Added user authentication middleware\ngit add src/middleware/auth.go\ngit commit\n# \ud83e\udd16 AI generates: \"feat(auth): implement JWT middleware with role-based access control\"\n```\n\n### **Database Schema Updates**\n```bash\n# Your changes: Added indexes for better performance\ngit add migrations/add_user_indexes.sql\ngit commit\n# \ud83e\udd16 AI generates: \"perf(db): add indexes on user table for faster queries\"\n```\n\n## \ud83c\udfe2 Team Adoption\n\n### **For JavaScript/TypeScript Teams**\n```json\n{\n \"devDependencies\": {\n \"smart-commits-ai\": \"^1.0.4\"\n },\n \"scripts\": {\n \"postinstall\": \"smart-commits-ai install\",\n \"commit\": \"git commit\"\n }\n}\n```\n\n### **For Any Team (Docker)**\n```bash\n# Add to team setup docs\necho 'alias smart-commits=\"docker run --rm -v $(pwd):/workspace joshi/smart-commits-ai\"' >> ~/.bashrc\n```\n\n### **For CI/CD Pipelines**\n```yaml\n# .github/workflows/commits.yml\n- uses: joshi-e8/smart-commits-ai-action@v1\n with:\n api_key: ${{ secrets.GROQ_API_KEY }}\n```\n\n---\n\n## \ud83d\udcc1 Project Structure\n\n```\nai-commit-generator/\n\u251c\u2500\u2500 README.md # This file\n\u251c\u2500\u2500 TEAM_SETUP_GUIDE.md # Detailed team documentation\n\u251c\u2500\u2500 pyproject.toml # Python package configuration\n\u251c\u2500\u2500 src/\n\u2502 \u2514\u2500\u2500 ai_commit_generator/\n\u2502 \u251c\u2500\u2500 __init__.py # Package initialization\n\u2502 \u251c\u2500\u2500 cli.py # Command-line interface\n\u2502 \u251c\u2500\u2500 core.py # Main commit generation logic\n\u2502 \u251c\u2500\u2500 config.py # Configuration management\n\u2502 \u251c\u2500\u2500 api_clients.py # AI API clients\n\u2502 \u2514\u2500\u2500 git_hook.py # Git hook management\n\u251c\u2500\u2500 templates/\n\u2502 \u251c\u2500\u2500 .commitgen.yml # Configuration template\n\u2502 \u2514\u2500\u2500 .env.example # Environment template\n\u251c\u2500\u2500 tests/ # Test suite\n\u251c\u2500\u2500 examples/ # Usage examples\n\u2514\u2500\u2500 legacy/ # Original bash scripts\n \u251c\u2500\u2500 install_hook.sh # Legacy installer\n \u2514\u2500\u2500 hooks/\n \u2514\u2500\u2500 prepare-commit-msg # Legacy hook script\n```\n\n---\n\n## \ud83d\udda5\ufe0f CLI Commands\n\n### Install Hook\n```bash\n# Install Git hook in current repository\nsmart-commits-ai install\n\n# Install with configuration files\nsmart-commits-ai install --config\n\n# Force overwrite existing hook\nsmart-commits-ai install --force\n```\n\n### Manage Installation\n```bash\n# Check installation status\nsmart-commits-ai status\n\n# Test with current staged changes\nsmart-commits-ai test\n\n# Uninstall hook\nsmart-commits-ai uninstall\n```\n\n### Generate Messages\n```bash\n# Generate message for staged changes\nsmart-commits-ai generate\n\n# Generate without writing to file (dry run)\nsmart-commits-ai generate --dry-run\n\n# Generate and save to specific file\nsmart-commits-ai generate --output commit-msg.txt\n```\n\n### Configuration\n```bash\n# Show current configuration\nsmart-commits-ai config --show\n\n# Validate configuration\nsmart-commits-ai config --validate\n```\n\n---\n\n## \ud83d\udd27 Configuration\n\n### Basic Setup (`.env`)\n```bash\n# Choose one provider\nGROQ_API_KEY=gsk_your_key_here\n# OPENROUTER_API_KEY=sk-or-your_key_here\n# COHERE_API_KEY=your_cohere_key_here\n```\n\n### Advanced Setup (`.commitgen.yml`)\n```yaml\napi:\n provider: groq\n \ncommit:\n max_chars: 72\n types: [feat, fix, docs, style, refactor, test, chore]\n scopes: [api, ui, auth, db, config]\n \nprompt:\n template: |\n Generate a conventional commit message for:\n {{diff}}\n```\n\n---\n\n## \ud83c\udfe2 Team Deployment\n\n### Option 1: Shared Network Drive\n```bash\n# Copy to shared location\ncp -r ai-commit-generator /shared/tools/\n\n# Team members install from shared location\n/shared/tools/ai-commit-generator/install_hook.sh\n```\n\n### Option 2: Internal Git Repository\n```bash\n# Create internal repo\ngit init ai-commit-generator\ngit add .\ngit commit -m \"feat: add AI commit message generator\"\ngit remote add origin https://github.com/your-org/ai-commit-generator.git\ngit push -u origin main\n\n# Team members clone and install\ngit clone https://github.com/your-org/ai-commit-generator.git\ncd your-project\n../ai-commit-generator/install_hook.sh\n```\n\n### Option 3: Package Distribution\n```bash\n# Create distributable package\ntar -czf ai-commit-generator.tar.gz ai-commit-generator/\n\n# Team members download and extract\ncurl -sSL https://your-server/ai-commit-generator.tar.gz | tar -xz\n./ai-commit-generator/install_hook.sh\n```\n\n---\n\n## \ud83d\udee0\ufe0f Advanced Usage\n\n### Custom Prompts\n```yaml\nprompt:\n template: |\n You are a senior developer. Generate a commit message for:\n \n {{diff}}\n \n Requirements:\n - Use conventional commits\n - Be specific about business impact\n - Maximum {{max_chars}} characters\n```\n\n### Multiple Models\n```bash\n# Fast and efficient\nGROQ_MODEL=llama3-8b-8192\n\n# More detailed\nGROQ_MODEL=llama3-70b-8192\n\n# Creative\nGROQ_MODEL=mixtral-8x7b-32768\n```\n\n### Debug Mode\n```bash\nDEBUG_ENABLED=true\ntail -f .commitgen.log\n```\n\n---\n\n## \ud83d\udea8 Troubleshooting\n\n| Issue | Solution |\n|-------|----------|\n| \"API key not found\" | Check `.env` file, ensure correct variable is set |\n| \"jq: command not found\" | Install jq: `brew install jq` or `apt install jq` |\n| \"Rate limit exceeded\" | Wait 1 minute or switch to different provider |\n| \"Hook not working\" | Reinstall: `./install_hook.sh` |\n\n---\n\n## \ud83d\udcca Provider Comparison\n\n| Provider | Speed | Cost | Models | Best For |\n|----------|-------|------|--------|----------|\n| **Groq** | \u26a1 Very Fast | \ud83c\udd93 Free | Llama 3, Mixtral | Teams, Daily Use |\n| **OpenRouter** | \ud83d\udc0c Medium | \ud83d\udcb0 Paid | Claude, GPT-4 | Premium Quality |\n| **Cohere** | \u2696\ufe0f Fast | \ud83c\udd93 Free Tier | Command-R | Enterprise |\n\n---\n\n## \ud83e\udd1d Contributing\n\n1. Fork the repository\n2. Create feature branch: `git checkout -b feature/amazing-feature`\n3. Commit changes: `git commit -m 'feat: add amazing feature'`\n4. Push to branch: `git push origin feature/amazing-feature`\n5. Open Pull Request\n\n---\n\n## \ud83d\udcc4 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n---\n\n## \ud83d\ude4f Acknowledgments\n\n- [Conventional Commits](https://www.conventionalcommits.org/) specification\n- [Groq](https://groq.com/) for fast AI inference\n- [OpenRouter](https://openrouter.ai/) for model diversity\n- [Cohere](https://cohere.ai/) for enterprise AI\n\n## \ud83c\udf89 Success Stories\n\n> **\"We migrated our entire React team (12 developers) to Smart Commits AI in one day. Now our commit history is consistent and descriptive!\"**\n> \u2014 Frontend Team Lead\n\n> **\"Works perfectly with our Flutter CI/CD pipeline. No Python knowledge required for the mobile team.\"**\n> \u2014 Mobile Developer\n\n> **\"The Docker approach was perfect for our polyglot microservices architecture.\"**\n> \u2014 DevOps Engineer\n\n## \ud83d\udcca Why Teams Choose Smart Commits AI\n\n| Team Type | Traditional Approach | With Smart Commits AI |\n|-----------|---------------------|----------------------|\n| **React/Next.js** | Inconsistent messages | Professional conventional commits |\n| **Flutter/Mobile** | \"fix\", \"update\" messages | Descriptive widget/feature commits |\n| **Backend APIs** | Generic descriptions | Specific endpoint/middleware commits |\n| **Full-Stack** | Mixed commit styles | Unified team standards |\n\n## \ud83d\udd17 Links\n\n- **\ud83d\udce6 PyPI Package**: https://pypi.org/project/smart-commits-ai/\n- **\ud83d\udce6 NPM Package**: https://www.npmjs.com/package/smart-commits-ai\n- **\ud83d\udc33 Docker Hub**: https://hub.docker.com/r/joshi/smart-commits-ai\n- **\ud83d\udcd6 Universal Installation Guide**: [UNIVERSAL_INSTALLATION.md](UNIVERSAL_INSTALLATION.md)\n- **\ud83c\udfe2 Team Setup Guide**: [TEAM_SETUP_GUIDE.md](TEAM_SETUP_GUIDE.md)\n\n---\n\n**Transform ANY team's commit messages today! \ud83d\ude80**\n\n*Works with React, Flutter, Go, Python, Java, C++, and every other language.*\n",
"bugtrack_url": null,
"license": null,
"summary": "Secure AI-powered Git commit message generator with enterprise-grade security. Automatically creates conventional commit messages using Groq, OpenRouter, or Cohere APIs. Source: https://github.com/Joshi-e8/ai-commit-generator.git",
"version": "1.1.0",
"project_urls": {
"Bug Reports": "https://github.com/Joshi-e8/ai-commit-generator/issues",
"Changelog": "https://github.com/Joshi-e8/ai-commit-generator/releases",
"Documentation": "https://github.com/Joshi-e8/ai-commit-generator#readme",
"Feature Requests": "https://github.com/Joshi-e8/ai-commit-generator/issues",
"Homepage": "https://github.com/Joshi-e8/ai-commit-generator",
"Issues": "https://github.com/Joshi-e8/ai-commit-generator/issues",
"Repository": "https://github.com/Joshi-e8/ai-commit-generator.git",
"Source Code": "https://github.com/Joshi-e8/ai-commit-generator"
},
"split_keywords": [
"git",
" commit",
" ai",
" conventional-commits",
" automation",
" groq",
" openrouter",
" cohere",
" llama",
" claude",
" gpt",
" developer-tools",
" productivity",
" git-hooks",
" commit-messages",
" machine-learning",
" natural-language-processing",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cc104aa09b9369b001ec476cedd4927e105130b40db138ed7a3b42e908572401",
"md5": "523997604306741bcc76f3592b6ec541",
"sha256": "1bc3bf40e4629f5bf7468cce9fe10ab9cb17b421d34a05762d9e6e39ea3417cf"
},
"downloads": -1,
"filename": "smart_commits_ai-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "523997604306741bcc76f3592b6ec541",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25609,
"upload_time": "2025-07-18T04:51:21",
"upload_time_iso_8601": "2025-07-18T04:51:21.994986Z",
"url": "https://files.pythonhosted.org/packages/cc/10/4aa09b9369b001ec476cedd4927e105130b40db138ed7a3b42e908572401/smart_commits_ai-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c47d1b7863dc01b6182588985982de90c791fb0a260fb9022e88eac8d704af8c",
"md5": "9f6cbbb7374f81bdd6243fcab7c57802",
"sha256": "3e0aa06cb6f63a926ce9f5d546a7de10e46d43dc495804d06b0ef2f679181b0e"
},
"downloads": -1,
"filename": "smart_commits_ai-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "9f6cbbb7374f81bdd6243fcab7c57802",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 29719,
"upload_time": "2025-07-18T04:51:23",
"upload_time_iso_8601": "2025-07-18T04:51:23.688262Z",
"url": "https://files.pythonhosted.org/packages/c4/7d/1b7863dc01b6182588985982de90c791fb0a260fb9022e88eac8d704af8c/smart_commits_ai-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 04:51:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Joshi-e8",
"github_project": "ai-commit-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.25.0"
]
]
},
{
"name": "pyyaml",
"specs": [
[
">=",
"6.0"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
">=",
"0.19.0"
]
]
},
{
"name": "rich",
"specs": [
[
">=",
"12.0.0"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"61.0"
]
]
}
],
"lcname": "smart-commits-ai"
}
JSON
