🚀 Gitp - AI-Powered Git Commits

Transform your git workflow with intelligent commit messages powered by AI! ✨

Stop wasting time writing commit messages and let AI do the heavy lifting. Gitp analyzes your changes and generates meaningful, contextual commit messages that actually make sense.

🚨 Important Changes

v1.0.3+ - Description Generation Now Optional

Breaking Change: Commit descriptions are no longer generated by default to improve speed and reduce token usage.

• Before: Gitp always generated both commit message and description
• Now: Only commit message is generated by default
• To get descriptions: Use the --description flag: gitp commit --description

This change makes commits faster while keeping the full functionality available when needed.

📸 See It In Action

git ca - Add files + commit

git cai - Interactive file staging

git cas - Smart AI analysis (waiting)

git cas - Smart AI analysis (result)

✨ Features

• 🤖 Multi-AI Provider Support - Works with OpenAI and Google
• 🎯 Smart Context Analysis - Understands your code changes for better messages
• 🎫 Automatic Ticket Integration - Links commits to Jira/GitHub/GitLab tickets
• 📝 Conventional Commits - Perfect for semantic-release workflows
• 🔍 Dry-run Mode - Preview before committing
• ⚡ Git Aliases - Lightning-fast shortcuts

📦 Installation

npm install -g gitp

🚀 Quick Start

🔧 Initial Setup

🔑 Set your AI provider and API key:

# Choose your AI provider
gitp set-provider openai     # 🤖 OpenAI GPT models
gitp set-provider google     # 🧠 Google Gemini

# Add your API key
gitp set-api-key <your-api-key>

# Pick your model
gitp set-model gpt-5         # For OpenAI
gitp set-model gemini-2.5-pro    # For Google

⚡ Git Aliases (Recommended!)

Get lightning-fast commits with simple aliases:

gitp add-alias

🎉 You now have these super shortcuts:

• git c → 💬 Smart commit
• git ca → 📁 Add files + smart commit
• git cs → 🧠 Smart commit with AI context
• git cas → 🚀 Add files + smart commit with AI context

🎫 Ticket Integration (Optional)

Link your commits automatically to project tickets:

gitp set-default-ticket-for /my-project ABC-123

📋 Conventional Commits (Optional)

Perfect for projects using semantic-release:

# Enable conventional commits for a project
gitp set-conventional-commits-for /my-awesome-project

# Remove if needed
gitp remove-conventional-commits-for /my-awesome-project

# See all configured projects
gitp list-conventional-commits

✨ Results in commits like:

• feat: ABC-123 add user authentication
• fix: ABC-123 resolve login timeout issue
• chore: update dependencies

💻 Usage

🎯 Basic Commands

💬 Generate and commit:

gitp commit

🔍 Preview mode (no actual commit):

gitp commit --dry-run

🧠 Smart AI analysis:

gitp commit --smart

📁 Auto-add files:

gitp commit --add

⚡ Power combo:

gitp commit --add --smart --no-verify

🎛️ All Options

| Flag | Description | Example | |------|-------------|---------| | --add | 📁 Auto-stage files | git ca | | --smart | 🧠 AI context analysis | git cs | | --description | 📝 Include commit description | gitp commit --description | | --dry-run | 🔍 Preview only | gitp commit --dry-run | | --no-verify | ⏭️ Skip git hooks | gitp commit --no-verify | | -y | 🚀 Skip confirmation | gitp commit -y |

🎬 Examples in Action

🚀 The Magic Happens

Before Gitp:

You: *stares at terminal for 5 minutes thinking of commit message*

With Gitp:

git ca  # Add files + smart commit

🎯 Interactive File Staging

Use git cai to selectively stage files with an interactive interface:

🧠 Smart Context Analysis

With Smart AI Analysis:

git cas  # Add + Smart AI commit with context analysis

🔄 Processing (AI analyzing your changes):

✨ Final Result:

🎯 Real-World Scenarios

🔧 Quick fixes:

git c        # Let AI figure out what you fixed

🧪 Feature development:

git cas      # Auto-add files + smart context analysis

🔍 Want to see first:

gitp commit --dry-run --smart

⚡ Ship it fast:

gitp commit --add -y    # No confirmation needed

🎫 With Ticket Integration

# Set once per project
gitp set-default-ticket-for /work/api-service TICKET-123

# Every commit gets prefixed automatically
git c
# → "feat: TICKET-123 add user profile endpoints"

🎯 Why Gitp?

🤔 Tired of:

• Spending minutes thinking of commit messages?
• Writing generic "fix stuff" commits?
• Forgetting to mention important changes?
• Inconsistent commit message formats?

✅ Get instead:

• 🚀 Lightning fast commits with AI
• 📝 Meaningful messages that actually describe your changes
• 🎯 Consistent formatting across your team
• 🧠 Smart context understanding of your code
• 🔄 Zero learning curve - works with your existing git workflow

🤝 Contributing

Found a bug or want a feature? We'd love your help!

1. 🍴 Fork the repo
2. 🌟 Create your feature branch
3. 💻 Make your changes
4. 🚀 Use git cas to commit (dogfooding!)
5. 📤 Push and create a PR

📜 License

MIT License - feel free to use in your projects! 🎉

Made with ❤️ for developers who value their time

Stop writing boring commit messages. Start using Gitp! 🚀