通用设置
调整类型展示模式、内联展示数量、隐藏字段、Skip CI 默认值和三个提交动作的显示状态。
Usage guide
安装、配置与日常使用
这份引导覆盖插件安装、提交面板动作、模板配置、提交类型维护、LLM Provider 配置和 Smart Echo 使用方式。
01
安装插件
在 JetBrains IDE 中进入插件市场安装：
- 打开
File→Settings→Plugins。 - 进入
Marketplace，搜索Git Commit Message Helper。 - 点击安装并按 IDE 提示重启。
02
提交面板工作流
插件会在 VCS Commit Message 区域中加入三个动作。它们可以在设置页里单独控制显示或隐藏。
动作
用途
Generate Commit Message
根据当前选中的变更生成提交信息。
Format Commit Message
把已有提交草稿重写为符合模板的格式。
Create Commit Message
打开结构化编辑窗口，手动填写字段并生成最终提交信息。
03
配置入口
设置入口为 File → Settings → Git Commit Message Helper。
提交模板
模板由 Apache Velocity 驱动，可以完全控制最终提交信息的渲染格式。
提交类型
维护团队允许使用的提交类型和描述，例如 feat、fix、docs、style、refactor、test、chore。
type(scope): subject
body
BREAKING CHANGE: changes
Closes issue
[skip ci]04
LLM Provider 设置
在 LLM 设置页配置 Provider、Base URL、API Key、Model、Temperature、Response Language 和 Smart Echo。
OpenAI Compatible
这是 OpenAI 兼容模式，适用于任何实现 Chat Completions 协议的服务。它的关键点是：插件最终会向 /chat/completions 发送请求。
- 填写服务根路径：
https://api.openai.com/v1，插件自动补成https://api.openai.com/v1/chat/completions。 - 填写完整接口：
https://example.com/v1/chat/completions，插件不会再追加路径。 - 鉴权 Header：
Authorization: Bearer <API Key>。 - 请求体字段：
model、temperature、stream、messages。
Base URL: https://api.openai.com/v1
Actual URL: https://api.openai.com/v1/chat/completions
Header: Authorization: Bearer sk-...Anthropic
这是 Anthropic 原生模式，适用于 Claude 官方 Messages API。它不走 OpenAI 兼容字段，Header 和请求体结构都按 Anthropic 协议组织。
- 填写服务根路径：
https://api.anthropic.com，插件自动请求https://api.anthropic.com/v1/messages。 - 鉴权 Header：
x-api-key: <API Key>。 - 版本 Header：
anthropic-version: 2023-06-01。 - 请求体字段：
model、system、messages、temperature、max_tokens、stream。
Base URL: https://api.anthropic.com
Actual URL: https://api.anthropic.com/v1/messages
Header: x-api-key: sk-ant-...Smart Echo：当提交面板里已有内容时，打开手动编辑器可以让 LLM 把现有文本解析回 type、scope、subject、body、changes、closes 和 skipCi 等结构化字段。它主要用于“继续编辑已有草稿”，不是重新生成一条完全新的提交信息。
05
截图说明
这里把设置页截图按功能说明放在正文中，便于对照配置项查看。图片均可点击放大。
通用设置
用于控制编辑器字段、提交动作按钮和 Skip CI。团队可以先决定哪些字段需要展示，再把无关项隐藏掉。
提交模板
Velocity 模板定义最终提交信息怎么拼接。你可以把字段顺序、空行、BREAKING CHANGE、issue 引用和 skip ci 放到团队约定的位置。
提交类型
提交类型列表用于约束 type 字段。默认包含 feat、fix、docs、style、refactor、perf、test、build、ci、chore 和 revert，也可以按团队规范增删。
LLM 设置
LLM 设置负责 Provider、接口地址、API Key、模型参数和 Smart Echo。生成、格式化和解析已有草稿都会读取这里的配置。