CommitPilot 🚁

AI-powered Git commit message generator for Visual Studio Code. Let AI help you write meaningful, consistent commit messages based on your staged changes.

Features

🤖 AI-Powered: Generate commit messages using OpenAI's GPT models
🔍 Smart Analysis: Analyzes your staged Git changes to understand the context
⚡ Quick Access: Generate commit messages with a single command or keyboard shortcut
🎯 Integrated: Works seamlessly with VS Code's Source Control panel
🛠️ Customizable: Configure AI model and other settings to fit your workflow

Installation

Open Visual Studio Code
Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
Search for "CommitPilot"
Click Install

Setup

Install the extension from VS Code Marketplace
Open the CommitPilot sidebar
If no API key is configured, you'll see a setup screen with instructions
Get an OpenAI API key from OpenAI Platform
Click "Open Settings" or use Command Palette: CommitPilot: Open Settings
Set your API key in "CommitPilot: OpenAI API Key"
Optionally configure:
- Model: Choose from gpt-3.5-turbo, gpt-4, gpt-4-turbo, gpt-4o, gpt-4o-mini
- Max Tokens: Control response length (50-500 tokens)

Note: The extension supports both OpenAI API keys and OpenRouter keys. It will automatically detect and configure the appropriate endpoint.

Usage

Click the extention in the Activity Bar to open CommitPilot sidebar
Stage your changes in Git
Click the sparkle icon (✨) next to the commit message input
AI will analyze your changes and generate a commit message
Review and edit if needed, then click "Commit"

Method 2: Command Palette

Stage your changes in Git
Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
Type "CommitPilot: Generate AI Commit Message"
AI will analyze your changes and suggest a commit message

Method 3: Keyboard Shortcut

Stage your changes in Git
Press Ctrl+Shift+G Ctrl+M (Windows/Linux) or Cmd+Shift+G Cmd+M (Mac)

Method 4: Source Control Panel

Stage your changes in Git
Click the sparkle icon (✨) in the Source Control panel toolbar

Commands

Command	Description	Keyboard Shortcut
`commitpilot.generateCommitMessage`	Generate AI commit message	`Ctrl+Shift+G Ctrl+M`
`commitpilot.getDiff`	Get staged Git diff	-
`commitpilot.openSettings`	Open CommitPilot settings	-
`commitpilot.test`	Test extension	-

Configuration

Access settings via: File > Preferences > Settings and search for "CommitPilot" or use the command CommitPilot: Open Settings.

Setting	Type	Default	Description
`commitpilot.openaiApiKey`	string	`""`	Your OpenAI API key for generating commit messages
`commitpilot.openaiModel`	string	`"gpt-3.5-turbo"`	OpenAI model: gpt-3.5-turbo, gpt-4, gpt-4-turbo, gpt-4o, gpt-4o-mini
`commitpilot.maxTokens`	number	`150`	Maximum tokens for commit message generation (50-500)

Contributing

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have suggestions, please open an issue on GitHub.

Changelog

See CHANGELOG.md for a list of changes and updates.

Enjoy coding with AI-powered commit messages! 🚁✨

CommitPilot

Dananjaya Bandara