Git Commit Genie

Overview

Git Commit Genie analyzes your staged Git diff and generates high‑quality Conventional Commits style messages using mainstream LLM providers (OpenAI / DeepSeek / Anthropic / Gemini / Qwen / GLM / Kimi / OpenRouter). Features intelligent repository analysis that understands your project structure and tech stack to provide better context for commit generation. Supports optional multi‑step Thinking mode and user template strategy to improve structural consistency and style alignment.

Commit message generate	Log dashboard
Status Bar Display

Format

By default, generated commit messages follow the Conventional Commits 1.0.0 specification. See the spec: https://www.conventionalcommits.org/en/v1.0.0/

Basic format:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Tips

Small or trivial commits: prefer a lightweight, fast model to speed up generation and reduce token usage.
Large, multi‑file commits: consider switching to a stronger model for better analysis and structure.
You can switch models anytime via "Git Commit Genie: Manage Models".
Toggle Thinking quickly via "Git Commit Genie: Enable / Disable thinking mode".

Core Features

Feature	Description
Multi‑provider LLM support	Supports OpenAI, DeepSeek, Anthropic, Gemini, Qwen, GLM, Kimi, OpenRouter.
Repository Intelligence	AI-powered repository analysis agent that autonomously explores your codebase using intelligent tools; automatically understands project structure, tech stack, and architecture to provide contextual insights for better commit messages; supports manual refresh, real-time updates, and editable analysis reports.
RAG (Retrieval-Augmented Generation)	Builds a local index of historical commit messages and retrieves style references via hybrid search (dense embeddings + BM25 keyword) to keep generated commit message style consistent with the repository. Requires an OpenAI-compatible embedding API. Supports incremental indexing and background repair.
Thinking Mode	Optional multi‑step pipeline: per‑file summaries → structured synthesis → validation & minimal fix‑ups (improves accuracy & template adherence).
User Template Strategy	Built-in template selection and creation, supports workspace and user data directory storage, extracts strategy affecting structure, required footers, and vocabulary preferences.
Conventional Commit Enforcement	Header validation (type, optional scope, optional `!`, ≤ 72 chars, imperative, no trailing period).
Diff Awareness	Only staged changes are analyzed; intelligently classifies type (`feat`, `fix`, `docs`, `refactor`, etc.).
Status Bar Integration	Shows current model and analysis status, click to access feature menu.
Cancellation	Cancel in‑progress generation directly from the SCM title bar button.
Secure Secret Storage	API keys stored in VS Code secret storage (not in settings JSON).
Internationalization	Built‑in English, Simplified Chinese, Traditional Chinese, and more.
Stage Notifications	Bottom‑right, progress notifications that show thinking stages.

How It Works

You stage your changes.
Run command: Git Commit Genie: Generate commit message (SCM toolbar button or Command Palette).
Result is injected into the repository input box—review / tweak / commit.

Configuration

All settings are under: Git Commit Genie.

Setting	Type	Default	Description
`gitCommitGenie.autoStageAllForDiff`	boolean	false	Only when the staging area is empty: temporarily stage all changes to build the diff, then restore your staging state. Use with caution—this may include unrelated changes in the prompt.
`gitCommitGenie.chain.enabled`	boolean	false	Enable multi-step Thinking mode for commit generation (more detailed and accurate, better template adherence, but higher latency and token usage).
`gitCommitGenie.chain.maxParallel`	number	2	Maximum parallel LLM calls used by Thinking mode across all providers. Increase carefully to avoid provider rate limits.
`gitCommitGenie.llm.maxRetries`	number	2	Max retry attempts for API request failures.
`gitCommitGenie.llm.temperature`	number	1	Temperature (0–2). Default 1. Some provider/model combinations only accept 1; changing this value may trigger invalid-temperature errors or less stable outputs.
`gitCommitGenie.rag.enabled`	boolean	false	Enable RAG to keep commit message generation style consistent (requires sufficient historical commits to build a local style index). Configure the embedding API key first via the "Configure RAG Embedding API Key" command.
`gitCommitGenie.rag.embedding.baseUrl`	string	`""`	Base URL for the embeddings API used by RAG. Must be compatible with OpenAI SDK format.
`gitCommitGenie.rag.embedding.model`	string	`""`	Embedding model used by RAG.
`gitCommitGenie.rag.embedding.dimensions`	number	0	Optional embedding dimensions used by RAG (0 = auto-detect).
`gitCommitGenie.rag.embedding.batchSize`	number	10	Batch size used when RAG generates embeddings (1–512).
`gitCommitGenie.repositoryAnalysis.enabled`	boolean	true	Enable repository analysis to provide better context for commit message generation.
`gitCommitGenie.repositoryAnalysis.excludePatterns`	array	[]	File patterns to exclude from repository analysis scanning (gitignore-style).
`gitCommitGenie.repositoryAnalysis.updateThreshold`	number	10	Number of commits after which to update the repository analysis.
`gitCommitGenie.repositoryAnalysis.MaxCount`	number	unlimited	Maximum number of analysis steps allowed during repository exploration. Set to -1 for unlimited steps (default).
`gitCommitGenie.repositoryAnalysis.model`	enum	general	Model used for repository analysis. Pick any supported model across providers; the provider automatically switches to match your selection. Choose "Use default model" to reuse your main commit message model. You can configure this via "Manage Models" command.
`gitCommitGenie.commitLanguage`	string	`auto`	Target language for generated commit messages. Options: `auto`, `en`, `zh-CN`, `zh-TW`, `ja`, `ko`, `de`, `fr`, `es`, `pt`, `ru`, `it`.
`gitCommitGenie.typingAnimationSpeed`	number	15	Speed of the commit message box typing animation in milliseconds per character. Set to -1 to disable the animation.
`gitCommitGenie.showUsageCost`	boolean	true	When enabled, a brief notification displays the estimated total cost for the current generation.
`gitCommitGenie.ui.stageNotifications.enabled`	boolean	true	Show bottom‑right stage notifications during Thinking. Title‑less minimal bubble.

Commands

Search these in the Command Palette:

Git Commit Genie: Generate commit message
Git Commit Genie: Stop generate (visible during generation)
Git Commit Genie: Manage Models
Git Commit Genie: Enable / Disable thinking mode
Git Commit Genie: Select/Create Template
Git Commit Genie: View Repository Analysis (opens analysis as editable Markdown)
Git Commit Genie: Refresh Repository Analysis (triggers new analysis)
Git Commit Genie: Clear Repository Analysis Cache (clears analysis cache)
Git Commit Genie: Cancel Repository Analysis (cancels analysis process)
Git Commit Genie: Configure RAG Embedding API Key (stores embedding API key in SecretStorage)
Git Commit Genie: Clear RAG Embedding API Key (removes embedding API key)
Git Commit Genie: Start RAG Indexing (indexes all historical commits for style retrieval)
Git Commit Genie: Stop RAG Indexing (cancels in-progress indexing)
Git Commit Genie: Menu
Git Commit Genie: Show Repository Cost
Git Commit Genie: Reset Repository Cost

SCM Title Bar shows “Generate commit message” or “Stop generate” depending on state.

Template Authoring

Using command Git Commit Genie: Select/Create Templateto select or create a template file.

When present & non‑empty, Genie attempts to extract a "Template Policy".

Full guides: English | 中文

Minimum example:

Minimal Template
- Always include a body with Summary and Changes.
- Use imperative, no trailing period.
- Always include a `Refs` footer (use `Refs: N/A` when missing).
- Prefer: add, fix, refactor; Avoid: update.

Security & Privacy

API keys stored via VS Code SecretStorage (not written to disk config in plain text).
Only staged diffs (file names & hunks) are sent; no untracked or unstaged changes.
No analytics/telemetry are collected by this extension.

License

MIT

Acknowledgements

Conventional Commits - https://github.com/conventional-commits/conventionalcommits.org
OpenAI / DeepSeek / Anthropic / Gemini / Qwen / GLM / Kimi / OpenRouter model ecosystems.

Never suffer through writing commit messages again.

Git Commit Genie

Lune

Git Commit Genie

Overview

Format

Tips

Core Features

How It Works

Configuration

Commands

Template Authoring

Security & Privacy

License

Acknowledgements