Git Commit Message Helper 在 IntelliJ 提交面板中的操作截图
IntelliJ Platform plugin · v1.6.2

Git CommitMessage Helper

把提交信息的生成、格式化和结构化编辑放进 IDE 提交面板,让团队提交记录更清晰、更一致。

  • Conventional Commits
  • Apache Velocity 模板
  • OpenAI Compatible / Anthropic
  • 中英日韩本地化
3 提交面板动作
11 默认提交类型
2020.3+ IntelliJ Platform

What it does

提交信息从草稿到规范输出,一次完成

根据变更生成提交信息

选择 Git 变更后,插件可以调用配置好的 LLM 生成提交信息草稿,适合快速处理上下文较多的修改。

格式化已有草稿

已经写好的提交信息可以被重写为当前模板格式,减少风格不一致和字段缺失。

结构化手动编辑

通过 type、scope、subject、body、BREAKING CHANGE、Closes、skip ci 等字段控制最终输出。

团队模板可定制

提交模板由 Apache Velocity 驱动,提交类型、字段显示、Skip CI 预设都可以按团队规范调整。

Daily workflow

直接从 Commit 面板进入工作流

01

选中变更

在 IntelliJ 的 Commit 工具窗口里选择本次要提交的文件或 diff。

02

生成、格式化或手写

使用 Generate、Format、Create 三个动作完成不同程度的自动化。

03

按模板输出

插件把结构化字段渲染为团队约定的最终 Git commit message。

Screenshots

截图和关键界面

查看带说明的截图引导

下面按实际使用顺序汇总插件界面。图片不是单独卡片,放在说明文字中作为文章插图;点击任意图片可以放大查看细节。

提交面板工作流

在 VCS Commit Message 区域中,插件会提供生成、格式化和手动创建三个入口。生成和格式化动作适合先拿到可用草稿,再由结构化编辑器进行人工确认。

提交面板里的三个动作会直接读写当前 commit message 文本。

通用设置

通用设置用于控制提交类型展示方式、隐藏字段、Skip CI 默认值,以及三个提交动作是否显示在提交面板中。

适合先配置团队默认行为,再让每次提交沿用同一套规则。

模板与提交类型

提交模板由 Apache Velocity 渲染,提交类型列表可以按团队规范维护。模板决定最终文本结构,类型列表决定编辑器中可以选择的语义分类。

模板中可以组合 type、scope、subject、body、breaking change、issue 和 skip ci。
提交类型和说明可以匹配团队自己的 Conventional Commits 约定。

LLM 设置

LLM 设置页集中配置 Provider、Base URL、API Key、模型、温度、返回语言和 Smart Echo。配置完成后,生成、格式化和回填结构化字段都会使用这里的参数。

OpenAI Compatible 和 Anthropic 两种 Provider 的请求路径、Header 和请求体结构不同。

Guide

快速使用引导

01

安装插件

在 IDE 中打开 FileSettingsPluginsMarketplace,搜索并安装 Git Commit Message Helper

02

打开设置页

进入 FileSettingsGitCommitMessageHelper,配置提交类型、模板、字段显示和 LLM。

03

在提交面板中使用

选择变更后点击 Generate Commit Message、Format Commit Message 或 Create Commit Message,确认结果后提交。

打开完整使用引导

LLM compatibility

两种 Provider 模式

OpenAI Compatible

这是“OpenAI 兼容模式”,适用于实现了 Chat Completions 协议的服务,不只限于 OpenAI 官方。Base URL 有两种写法:

  • 如果填写 https://api.openai.com/v1 这类服务根路径,插件会自动补上 /chat/completions
  • 如果已经填写完整的 https://example.com/v1/chat/completions,插件会直接使用这个地址。
  • 请求 Header 使用 Authorization: Bearer <API Key>,请求体包含 modeltemperaturestreammessages

Anthropic

这是 Anthropic 原生 Messages API 模式,适用于 Claude 官方接口。它不是 OpenAI 兼容转接,协议字段和 Header 都不同。

  • Base URL 通常填写 https://api.anthropic.com,插件会自动请求 /v1/messages
  • 请求 Header 使用 x-api-keyanthropic-version: 2023-06-01
  • 请求体包含 modelsystemmessagestemperaturemax_tokensstream

Smart Echo

Smart Echo 不是生成新提交信息,而是把当前 commit message 文本解析回结构化字段。打开手动编辑器时,如果提交面板里已有内容,它会尝试识别 typescopesubjectbodychangesclosesskipCi,方便在原草稿基础上继续调整。

Ready

让提交信息保持同一种语言

截图预览