TippaniAI

Generate meaningful Git commit messages instantly using AI. Save time and improve your commit quality with intelligent analysis of your code changes.

✨ Features

• 🤖 AI-Powered: Analyzes your git diff and generates contextually appropriate commit messages
• 🎨 Multiple Styles: Choose from conventional commits, descriptive messages, emoji style, or create custom formats
• ⚡ One-Click Generation: Seamlessly integrated into VS Code's Source Control panel
• 🔧 Highly Configurable: Customize AI model, commit style, token limits, and more
• 📝 Smart Analysis: Works with both staged and unstaged changes
• 🚀 Fast & Efficient: Powered by OpenAI's latest GPT models

🚀 Quick Start

1. Install the extension from the VS Code Marketplace
2. Get your OpenAI API key from OpenAI Platform
3. Configure the extension:
   • Open VS Code Settings (Ctrl+,)
   • Search for "TippaniAI"
   • Add your OpenAI API key
4. Start generating commits:
   • Make changes to your code
   • Open Source Control panel (Ctrl+Shift+G)
   • Click the "Generate AI Commit Message" button
   • Review and commit!

🎯 How It Works

1. Make your changes - Edit files in your workspace
2. Stage changes (optional) - The extension works with staged or unstaged changes
3. Generate commit message - Click the AI button in Source Control or use Ctrl+Shift+G → Ctrl+A
4. Review and commit - The generated message appears in the commit input box

📋 Usage

Method 1: Source Control Panel

• Open Source Control (Ctrl+Shift+G)
• Click the AI commit button 🤖 in the toolbar
• Generated message appears in the commit input box

Method 2: Command Palette

• Open Command Palette (Ctrl+Shift+P)
• Type "Generate AI Commit Message"
• Press Enter

Method 3: Keyboard Shortcut

• Press Ctrl+Shift+G then Ctrl+A

🎨 Commit Styles

Choose from multiple commit message styles to match your workflow:

Conventional Commits

Perfect for teams following conventional commit standards:

feat(auth): add JWT token validation
fix(api): resolve user session timeout
docs(readme): update installation guide

Descriptive Style

Clean, readable commit messages:

Add user authentication with JWT tokens
Fix memory leak in data processing pipeline
Update API documentation with examples

Emoji Style

Fun and visually appealing commits:

✨ Add user authentication system
🐛 Fix memory leak in data processing
📝 Update API documentation
🎨 Improve code structure and formatting

Custom Style

Create your own commit message format with custom prompts.

⚙️ Configuration

Required Settings

• OpenAI API Key - Get yours from OpenAI Platform

Optional Settings

Configure these in VS Code Settings (Ctrl+,) under "TippaniAI" (search for "tippaniAI"):

🔧 Advanced Features

• Smart Diff Analysis: Automatically detects staged vs unstaged changes
• Token Optimization: Truncates large diffs to stay within API limits
• Error Handling: Comprehensive error messages with helpful suggestions
• Progress Indicators: Visual feedback during AI generation
• Secure Configuration: API keys stored safely in VS Code settings

💡 Tips

• Stage your changes for more focused commit messages
• Use conventional commits for better project history
• Try different models - GPT-4o for complex changes, GPT-4o-mini for speed
• Customize the style to match your team's conventions

🛠️ Requirements

• VS Code 1.74.0 or higher
• Active Git repository
• OpenAI API key
• Internet connection for API calls

🔒 Privacy & Security

• API keys are stored securely in VS Code settings
• Git diffs are sent to OpenAI for analysis
• Large diffs are automatically truncated
• No data is stored or cached by the extension

📊 Pricing

This extension uses OpenAI's API. Typical usage costs:

• GPT-4o-mini: ~$0.01 per 100 commits
• GPT-4o: ~$0.10 per 100 commits

Costs may vary based on diff size and message length.

🚀 Getting Started

Step 1: Install

Install from the VS Code Marketplace

Step 2: Configure

1. Get your OpenAI API key from OpenAI Platform
2. Open VS Code Settings (Ctrl+,)
3. Search for "tippaniAI" or "TippaniAI"
4. Paste your API key in the "OpenAI API Key" field

Step 3: Generate

1. Make changes to your code
2. Open Source Control (Ctrl+Shift+G)
3. Click the AI commit button 🤖
4. Review and commit!

🎯 Perfect For

• Solo developers who want consistent, professional commit messages
• Teams following conventional commit standards
• Open source projects maintaining clean commit histories
• Anyone tired of writing "fix stuff" commit messages!

📈 Why Use AI Commit Generator?

• Save Time: No more thinking about how to phrase commits
• Improve Quality: Consistent, descriptive commit messages
• Better History: Clean, searchable project history
• Team Consistency: Everyone follows the same commit standards
• Professional: Impress collaborators with well-crafted messages

🤝 Support

• Issues: GitHub Issues
• Feature Requests: GitHub Discussions
• Documentation: Wiki

📝 License

MIT License - see LICENSE file for details.

⭐ Show Your Support

If this extension helps you write better commits, please:

• ⭐ Star the GitHub repository
• 📝 Write a review on the VS Code Marketplace
• 🐛 Report issues or suggest features

Made with ❤️ by Sandeep Pal for developers who care about clean commit history

Version: 1.0.2