🤖 Commitor

AI-powered Git commit message generator

---

📦 Packages

This monorepo contains three packages:

Package	Description	Version
commitor	🖥️ CLI tool for terminal usage
@commitor/core	🔧 Core library for developers
commitor-vscode	💻 VSCode extension

✨ Features

• 🎯 AI-Powered: Generate meaningful commit messages using OpenAI (GPT-4o-mini) or Anthropic (Claude Sonnet 4.5)
• 🔄 Hybrid Connection: Use API keys OR browser automation (no API key required!)
• 🌍 Multi-Language Support: Auto-detects language from README + git history, or specify any language
• ✅ Instant Validation: Setup wizard validates API keys in real-time
• 📝 Conventional Commits: Follows industry-standard commit message format
• ✨ Interactive Preview: Review and edit messages before committing
• 🔒 Secure Storage: Encrypted API key and session management
• 🚀 Multiple Interfaces: CLI, VSCode extension, or integrate the core library

🚀 Quick Start

CLI Installation

npm install -g commitor

First Time Setup

# Run setup wizard
commitor init

# Choose your AI provider (OpenAI or Anthropic)
# Select connection type (API or Browser)
# Enter API key (if using API mode)
# Select language preference

Usage

# Stage your changes
git add .

# Generate and commit with AI
commitor

That's it! Commitor will:

1. Analyze your staged changes
2. Generate a meaningful commit message
3. Let you preview and edit
4. Commit with the final message

📦 Installation Options

For End Users

CLI (Terminal)

npm install -g commitor

VSCode Extension

Search "Commitor" in VSCode Extensions or install from marketplace

For Developers

Core Library

npm install @commitor/core

import { CommitGenerator } from '@commitor/core';

const generator = new CommitGenerator({
  provider: 'openai',
  connectionType: 'api',
  apiKey: 'your-api-key'
});

const message = await generator.generate({
  diff: gitDiffOutput,
  language: 'en'
});

💻 VSCode Extension

Commitor is also available as a VSCode extension for seamless editor integration!

Features

• ✨ One-click AI commit message generation from Source Control panel
• 🔑 Secure API key storage using VSCode Secrets API
• 📊 Real-time status bar integration
• ⚙️ Easy configuration via Command Palette or Settings UI
• 🎨 Beautiful configuration panel with visual feedback
• 🔄 Supports both OpenAI and Anthropic

Installation

From VSCode Marketplace:

1. Open VSCode
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
3. Search for "Commitor"
4. Click Install

Or install directly:

code --install-extension frkngnc.commitor-vscode

📦 View on VSCode Marketplace

📚 Documentation

• CLI Usage Guide - Detailed CLI commands and options
• Development Guide - Setup development environment
• Core API Documentation - Use @commitor/core in your projects
• Contributing Guidelines - How to contribute

🛠️ Available Commands

CLI Commands

commitor init      # Initial setup wizard
commitor           # Generate and commit message
commitor config    # View/edit configuration
commitor logout    # Clear session and API keys
commitor --help    # Show help
commitor --version # Show version

VSCode Commands

• Commitor: Generate AI Commit Message - Generate commit message
• Commitor: Configure AI Provider - Quick configuration
• Commitor: Open Configuration Panel - Full settings UI
• Commitor: Change Language - Switch message language
• Commitor: Logout - Clear API keys
• Commitor: Check Provider Health - Test AI provider connection

🤝 Contributing

We welcome contributions! Here's how you can help:

1. 🐛 Report bugs - Open an issue
2. 💡 Suggest features - Start a discussion
3. 📝 Improve docs - Submit a PR with documentation improvements
4. 🔧 Submit PRs - Check CONTRIBUTING.md for guidelines

📄 License

MIT © Furkan Genç

⭐ Show Your Support

If you find Commitor useful, please consider:

• ⭐ Starring the repository
• 🐦 Sharing on social media
• 📝 Writing a blog post or review
• 🔧 Contributing to the project

🔗 Links

• npm Package (CLI)
• npm Package (Core)
• VSCode Marketplace
• GitHub Repository
• Issue Tracker
• Discussions

---

Made with by frkngnc