AI Commit Message Generator

Generate meaningful commit messages automatically using AI. Analyzes your staged changes and creates Conventional Commits formatted messages in seconds.

Features

• Multi-provider support - Choose from OpenAI, Groq, Google Gemini, or Ollama (offline)
• 3 commit message candidates - Pick the best one from AI-generated options
• PR description generation - Auto-generate structured PR descriptions from your changes
• Issue linking - Auto-detect issue numbers from branch names (GitHub, GitLab, JIRA)
• Korean language support - Generate commit messages in Korean
• Conventional Commits format for consistent, semantic versioning friendly messages
• Sensitive information masking - Automatically masks API keys, passwords, tokens before sending to AI
• Smart diff summarization - AI summarizes large diffs for better commit messages
• Team ruleset support - Enforce commit conventions via .commitrc.json
• Multi-repo workspace support with repository picker
• Secure API key storage using VS Code's built-in SecretStorage
• Configurable exclusions to filter out noise from diffs (lock files, build artifacts, etc.)
• Smart handling of existing commit messages (overwrite/append options)
• CLI version - Use from terminal with commitcraft command

What's New in v0.2.0

Ollama Support (Offline Mode)

Run AI commit message generation completely offline using local LLMs via Ollama. No API key required!

Sensitive Information Masking

Automatically detects and masks sensitive data before sending to AI:

• API keys (OpenAI, AWS, GitHub, Stripe, etc.)
• Passwords and secrets in config files
• Connection strings and tokens
• Private keys

Smart Diff Summarization

For large diffs (>8000 chars by default), the extension first summarizes the changes using AI, then generates commit messages from the summary for better results.

Team Ruleset Support

Create a .commitrc.json file in your project root to enforce team conventions:

• Allowed commit types and scopes
• Required scopes
• Max subject length
• Custom prompts for AI
• Language override

PR Description Generation

Automatically generate well-structured PR descriptions with:

• Title (max 50 chars)
• Summary section
• Changes bullet list
• Testing instructions

Opens in a new editor tab with "Copy to Clipboard" option.

Issue Linking

Automatically extract issue numbers from branch names and include them in commit messages:

• Configure issueBranchPattern to extract issue from branch (e.g., feature/(\d+) extracts 123 from feature/123-login)
• Configure issuePrefix to format the reference (e.g., # → #123)
• Works with GitHub, GitLab, JIRA, and custom issue systems

Example: Branch feature/123-add-login → Commit: feat(auth): add login validation [#123](https://github.com/youngsikkk/ai-commit-msg/issues/123)

Installation

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
3. Search for "AI Commit Message Generator"
4. Click Install

Usage

1. Stage your changes with git add
2. Run the command:
   • Press Ctrl+Shift+G (Windows/Linux) or Cmd+Shift+G (Mac)
   • Or open Command Palette (Ctrl+Shift+P) and type "AI Commit: Generate"
3. Enter your API key when prompted (first time only, not required for Ollama)
4. Choose from 3 generated candidates or click "Regenerate" for new options
5. The selected message appears in the Source Control input box
6. Review and commit!

Configuration

Default Models by Provider

Default Exclusions

["node_modules", "*.lock", "dist", "build", "*.min.*"]

Team Ruleset (.commitrc.json)

Create a .commitrc.json file in your project root to enforce team conventions:

{
  "allowedTypes": ["feat", "fix", "docs", "refactor", "test"],
  "requireScope": true,
  "allowedScopes": ["api", "ui", "core", "config"],
  "maxSubjectLength": 72,
  "language": "english",
  "customPrompt": "Always mention the ticket number if visible in the diff"
}

Ruleset Options

When a generated commit doesn't match the ruleset, you'll get options to:

• Use Anyway - Use the commit message as-is
• Regenerate - Generate new candidates
• Cancel - Abort the operation

Ollama Setup

1. Install Ollama
2. Pull a model: ollama pull llama3.2
3. Start Ollama (runs automatically on install)
4. Set provider to ollama in VS Code settings
5. (Optional) Set custom URL with AI Commit: Set Ollama URL

Issue Linking Setup

Configure issue extraction from branch names:

GitHub/GitLab Issues

// settings.json
{
  "aiCommit.issuePrefix": "#",
  "aiCommit.issueBranchPattern": "feature/(\\d+)"
}

Branch feature/123-add-login → #123

JIRA Issues

{
  "aiCommit.issuePrefix": "",
  "aiCommit.issueBranchPattern": "(PROJ-\\d+)"
}

Branch feature/PROJ-456-fix-bug → PROJ-456

Custom Pattern Examples

CLI Version

Use CommitCraft from your terminal without VS Code!

Installation

npm install -g commitcraft-cli

Quick Usage

# Stage changes and generate commit message
git add .
commitcraft

# Auto-commit with selected message
commitcraft --commit

# Use specific provider
commitcraft -p groq
commitcraft -p ollama

# Korean language
commitcraft -l korean

CLI Options

commitcraft generate [options]

Options:
  -p, --provider <provider>  AI provider (openai, groq, gemini, ollama)
  -m, --model <model>        Model to use
  -l, --language <language>  Language (english, korean)
  -c, --commit               Auto-commit with selected message
  --issue-pattern <pattern>  Regex to extract issue from branch
  --issue-prefix <prefix>    Prefix for issue (e.g., #)

CLI Configuration

# Interactive configuration
commitcraft config

# Or set environment variables
export OPENAI_API_KEY="sk-..."
export GROQ_API_KEY="gsk_..."

See CLI README for detailed documentation.

Supported Commit Types

Commands

Keybindings

Requirements

• VS Code 1.107.0 or higher
• Git installed and repository initialized
• API key for your chosen provider (not required for Ollama):
  • OpenAI
  • Groq
  • Google AI Studio (Gemini)
  • Ollama (local, no API key needed)

Security

Your API keys are stored securely using VS Code's SecretStorage API. They are never exposed in settings, logs, or transmitted anywhere except to the respective AI provider's API.

Sensitive Information Masking (enabled by default) automatically detects and masks:

• API keys (OpenAI, AWS, GitHub, Stripe, Google, Azure, etc.)
• Passwords and secrets in configuration files
• Database connection strings
• JWT tokens and bearer tokens
• Private keys (RSA, SSH, PGP)

This ensures your sensitive data is never sent to AI providers.

License

MIT License - see LICENSE for details.

Happy committing!