🤖 AICommit

Transform your Git workflow with AI-powered commit messages

Stop writing boring commits. Start writing professional ones.

---

🎯 The Problem Every Developer Faces

😩 Your Current Reality git commit -m "fix" git commit -m "update stuff" git commit -m "changes" git commit -m "wip" git commit -m "final fix" git commit -m "final fix for real" git commit -m "ok this time it works" Result: Messy git history, confused teammates, failed code reviews

✨ With AICommit ✨ feat(auth): implement OAuth2 social login 🐛 fix(api): resolve memory leak in user service 📝 docs(readme): add comprehensive setup guide ♻️ refactor(db): optimize query performance 🔧 chore(deps): update security dependencies Result: Professional commits, clear history, happy team

---

🌟 Why AICommit is Different

🔒 100% Private. 100% Local. 100% Yours.

The only AI commit tool that keeps your code on YOUR machine

🏠 Local AI No cloud services No API keys No data sharing Complete privacy

⚡ Lightning Fast Instant responses No network delays Works offline Always available

🧠 Context Aware Understands your changes Adapts message length Follows conventions Learns your patterns

🎯 Professional Conventional commits Perfect formatting Relevant emojis Team consistency

---

📊 Real Usage Statistics

📦 Weekly Downloads 446+ developers choose AICommit weekly

⭐ GitHub Community Growing open source community

🔐 Privacy Score Zero data collection

---

🚀 Quick Start (2 Minutes Setup)

Get professional commits in 4 simple steps

📦 Step 1: Install AICommit

Global Installation (Recommended) npm install -g @abd3lraouf/aicommit

Local Installation npm install @abd3lraouf/aicommit npx aicommit

📋 Other Package Managers

# Using Yarn
yarn global add @abd3lraouf/aicommit

# Using pnpm
pnpm add -g @abd3lraouf/aicommit

# Using Bun
bun add -g @abd3lraouf/aicommit

🧠 Step 2: Setup Local AI (LM Studio)

Why LM Studio? User-friendly, optimized, and works perfectly with AICommit

1. Download Get LM Studio (Windows/Mac/Linux)

2. Install Model Search: qwen3-4b-teen-emo (4GB, fast & accurate)

3. Load Model Click "Load Model" Select downloaded model

4. Start Server Click "Start Server" Runs on localhost:1234

⚙️ Step 3: Configure AICommit

aicommit config

Interactive wizard guides you through everything!

🎉 Step 4: Experience the Magic

# Stage your changes
git add .

# Generate professional commit
aicommit

🎊 Watch AICommit generate:

✨ feat(auth): implement secure user authentication

Add JWT-based authentication system with password hashing.

- Create login/register endpoints with validation
- Implement secure password hashing with bcrypt
- Add JWT token generation and verification middleware

---

💡 Usage Examples

🔧 Command Options

# Basic usage aicommit # Interactive mode (review before commit) aicommit --interactive # Dry run (see message without committing) aicommit --dry-run

# Verbose output aicommit --verbose # Debug information aicommit --debug # Show help aicommit --help

📝 Real Commit Examples

🐛 Small Bug Fix (1-2 files)

🐛 fix(ui): correct button alignment issue

Fix misaligned submit button on the login form.

- Adjust CSS flexbox properties for proper centering

✨ New Feature (3-5 files)

✨ feat(auth): implement user registration

Add complete user registration system with validation and email confirmation.

- Create registration form with input validation
- Add email confirmation workflow
- Implement password strength requirements
- Add user account activation process

♻️ Major Refactor (6+ files)

♻️ refactor(api): restructure authentication system

Modernize authentication architecture for better security and maintainability.

- Replace JWT with session-based authentication
- Add OAuth2 integration for social login
- Implement role-based access control (RBAC)
- Create authentication middleware pipeline
- Add comprehensive security headers
- Update API documentation for auth endpoints

---

⚙️ Configuration

🎛️ Configuration Options

API Settings { "api": { "host": "localhost", "port": 1234, "model": "qwen3-4b-teen-emo", "timeout": 30000 } }

CLI Settings { "cli": { "interactive": false, "verbose": true, "debug": false, "dryRun": false } }

📋 Configuration Priority

1. Command line arguments (--api-host=localhost)
2. Local .aicommitrc.json (in your project)
3. Global .aicommitrc.json (in your home directory)
4. Environment variables (AI_API_HOST=localhost)
5. Default values

---

🎯 Commit Types & Emojis

AICommit automatically chooses the perfect type and emoji

Type	Emoji	When to use	Example
feat	✨	New features	✨ feat(auth): add OAuth login
fix	🐛	Bug fixes	🐛 fix(api): resolve memory leak
docs	📝	Documentation	📝 docs(readme): update setup guide
refactor	♻️	Code restructuring	♻️ refactor(db): optimize queries
perf	⚡	Performance	⚡ perf(api): cache responses
test	✅	Adding tests	✅ test(auth): add unit tests

---

🔧 Troubleshooting

❌ "No changes detected"

Solution: Make sure you've staged your changes

git add .
aicommit

🔌 "API connection failed"

Solutions:

• Check that LM Studio is running
• Verify the model is loaded
• Test connection: curl http://localhost:1234/v1/models

📁 "Not in a git repository"

Solution: Initialize a Git repository

git init
git add .
aicommit

🔍 Debug Mode

Get detailed information:

aicommit --debug

Shows:

• Change analysis
• AI prompt sent
• Raw AI response
• Final message formatting

---

🏗️ How It Works

The AICommit Process

1. Analyze 📊 Examines your staged Git changes

2. Understand 🧠 Determines scope and complexity

3. Generate ⚡ Creates intelligent prompt for AI

4. Format 📝 Converts to conventional commit

5. Commit ✅ Applies to your repository

---

🤝 Contributing

Help make AICommit even better!

We welcome contributions from developers of all skill levels!

---

📞 Support & Community

---

⭐ Show Your Support

If AICommit improved your workflow, give us a star!

Share with your team:

---

📄 License

MIT License - Free to use in your projects!

Made with ❤️ by Abdelraouf Sabri

---

🚀 Ready to transform your Git workflow?

Join the growing community of developers using local AI for better commits!