Appearance
AI Commit Message(VSCode 插件)
用 AI 一键生成 git commit message 的本地自建 VSCode 插件。支持两种来源:
- 本地 / 系统(免 key):复用本机已登录的 Claude Code CLI / OpenAI Codex,无需 API Key。
- 自定义网关(流式):填入 OpenAI 兼容网关的 API Key 与地址,拉取模型列表后选用,生成时流式打字输出到提交框。
下载安装
⬇ 下载 commit-gen v0.2.4commit-gen-0.2.4.vsix · 20 KB · 构建于 2026-07-16
这里始终只提供最新版本的安装包,每次文档构建会自动同步。
安装步骤:
- 点上方按钮下载
.vsix文件。 - VSCode 打开扩展面板 → 右上角
...菜单 → 从 VSIX 安装…(Install from VSIX...) → 选择刚下载的文件。 - 安装后
Cmd/Ctrl + Shift + P执行 Developer: Reload Window 重载窗口。
也可用命令行安装:
code --install-extension commit-gen-x.y.z.vsix --force
快速使用
- 在 VSCode 左侧打开**源代码管理(Source Control)**面板。
- 顶部工具栏点击 🤖 AI: 生成 Commit Message 图标。
- 插件读取当前改动(默认含未暂存/未跟踪文件),调用所选模型生成,并写入提交框。
- 走网关流式时,提交框会平滑地逐字"打字"出来,并能看到真实进度;
- 走本地 CLI时,生成完成后一次性写入。
默认用「工作区全部更改」生成,无需先
git add;可在设置commitGen.includeUnstaged关闭,改为只用暂存区。
选择模型
命令面板或 SCM 菜单执行 AI: 切换 Commit 生成模型,列表分为两组:
| 分组 | 选项 | 路由 | 流式 |
|---|---|---|---|
| 本地 / 系统(免 key) | 默认(Claude Code 当前模型) | 本机 Claude CLI | 否 |
| 本地 / 系统(免 key) | claude-sonnet-4-6 / claude-opus-4-8 | 本机 Claude CLI | 否 |
| 本地 / 系统(免 key) | GPT(Codex 本地登录) | 本机 Codex CLI | 否 |
| 网关(API Key) | 从网关 /v1/models 拉取的全部模型 | 自定义网关 | 是 |
要点:
- 想要流式输出:从「网关」分组里选模型(需先配置 API Key)。
- 想免 key 本地跑:用「本地 / 系统」分组。
- 同名模型(如
claude-opus)可同时存在于两组,按你选的来源决定走本机还是网关,互不冲突。
配置 API Key 与地址
执行 AI: 配置(密钥 / 地址 / 模型) 打开配置面板(类 Cherry Studio 简版):
- 填 API 密钥(保存到
commitGen.openaiApiKey,也可用环境变量OPENAI_API_KEY)。 - 填 API 地址,默认
https://new-api.cocos.org(OpenAI 兼容网关)。 - 点 获取模型列表 → 列表中点击任意模型即选中(标记为网关来源,走流式)。
也可以在 VSCode 设置里搜索 commitGen 手动配置。
自定义内容规范
执行 AI: 切换 Commit 内容规范 选择预设,或选「自定义…」进入设置页编辑 commitGen.styleInstruction(已设为多行文本框,可完整查看与编辑)。内置预设:
- 中文 · 列点(1. 2. 3.):type 前缀主题 + 正文按
1. 2. 3.编号逐条列出改动。 - English · numbered list (1. 2. 3.)
- 简洁单行(中文)
日志与耗时
执行 AI: 显示 Commit 生成日志(或 Output 面板选「AI Commit」)查看详细日志,包含每次生成的请求到完成耗时,例如:
生成结果(网关 · deepseek-v3.2, 耗时 2.34s): feat: ...
已写入提交框 ✔ 总耗时 2.34s配置项一览
| 配置项 | 说明 | 默认 |
|---|---|---|
commitGen.model | 使用的模型(留空=默认) | "" |
commitGen.modelSource | 模型来源:cli / codex / gateway,一般自动设置 | "" |
commitGen.openaiApiKey | 网关 API Key(流式) | "" |
commitGen.openaiBaseUrl | 网关地址 | https://new-api.cocos.org |
commitGen.apiKey | Anthropic API Key(CLI 不可用时回退) | "" |
commitGen.apiBaseUrl | Anthropic API 地址 | https://api.anthropic.com |
commitGen.claudePath | claude CLI 路径 | claude |
commitGen.codexPath | codex CLI 路径 | codex |
commitGen.styleInstruction | commit 风格指引(多行) | 见预设 |
commitGen.includeUnstaged | 是否包含未暂存改动 | true |
commitGen.backend | auto / cli / api | auto |
常见问题
- 选了模型却没流式输出? 流式只在「网关」分组(自定义 API Key)的模型上生效;本地 CLI / Codex 不流式。
- 提示"生成结果为空 / 不支持流式"? 该模型或网关可能不支持流式,按提示切换模型重试即可。
- 报错没地方配置 Key? 错误弹窗里点 去配置 / 切换模型,或执行 AI: 配置。