GitFathom

一款用于生成高质量 Git 提交信息的 VS Code 扩展，支持多厂商模型与可视化配置，生成结果会自动写入 Source Control 输入框。

English

功能特性

• Git 面板一键生成提交信息（图标按钮）
• 命令面板配置向导（Ctrl+Shift+P）
• 支持 OpenAI / DeepSeek / Gemini / Kimi / GLM / 自定义兼容厂商
• 支持自定义 Base URL、请求路径、额外请求头
• 中英双语 UI 与提交信息输出
• 支持仅暂存区生成、可选详细/简洁输出
• 可选复制到剪贴板，内置 AI 调试报告视图
• 性能友好：限制 diff 大小、控制超时、无后台轮询

安装与调试

1. 安装依赖

   npm install
   

2. 编译

   npm run compile
   
   vsce package
   

3. 按 F5 启动扩展开发宿主

快速开始

1. 按 Ctrl+Shift+P，运行 GitFathom: Open Setup Wizard
2. 选择语言、厂商与模型
3. 配置 API Key / Base URL / Headers
4. 打开任意 Git 仓库，在 Git 面板点击图标按钮生成提交信息

常用设置

• gitgathom.language: zh | en
• gitgathom.provider: openai | deepseek | gemini | kimi | glm | custom
• gitgathom.model
• gitgathom.apiKey
• gitgathom.baseUrl
• gitgathom.customRequestPath（OpenAI 默认 /chat/completions，其它厂商默认空）
• gitgathom.extraHeaders
• gitgathom.systemPrompt
• gitgathom.ruleTemplate
• gitgathom.additionalRules
• gitgathom.detailedOutput
• gitgathom.includeOnlyStaged
• gitgathom.maxChangedFiles
• gitgathom.truncateDiff
• gitgathom.maxDiffBytes（仅在 truncateDiff=true 时生效）
• gitgathom.temperature
• gitgathom.maxTokens（可设为 null 表示不限制）
• gitgathom.requestTimeoutMs
• gitgathom.commandTimeoutMs
• gitgathom.copyToClipboard
• gitgathom.debugView

AI 调试可视化

• 开启 gitgathom.debugView 后，每次生成都会自动打开一份调试文档
• 文档包含：发送给 AI 的 system/user prompt、请求头/请求体、AI 原始响应、解析结果
• 同时提供命令 GitFathom: Show Last AI Debug Report，可随时再次查看最近一次报告

环境变量

当 gitgathom.apiKey 为空时，会尝试读取：

• OPENAI_API_KEY
• DEEPSEEK_API_KEY
• GEMINI_API_KEY
• MOONSHOT_API_KEY
• ZHIPU_API_KEY
• GITFATHOM_API_KEY

English

GitFathom is a VS Code extension that generates high-quality Git commit messages and writes them into the Source Control input box.

Features

• One-click commit message generation in Git panel (icon button)
• Setup wizard via Command Palette (Ctrl+Shift+P)
• Providers: OpenAI / DeepSeek / Gemini / Kimi / GLM / Custom OpenAI-compatible
• Custom Base URL, request path, and extra headers
• Bilingual UI and output (zh/en)
• Optional staged-only input and detailed/concise output modes
• Optional clipboard copy with AI debug report view
• Performance-friendly defaults: bounded diff size, timeouts, no background polling

Setup

1. Install dependencies

   npm install
   

2. Compile

   npm run compile
   

3. Press F5 to launch the Extension Development Host

Quick Start

1. Press Ctrl+Shift+P, run GitFathom: Open Setup Wizard
2. Select language, provider, and model
3. Configure API key / Base URL / headers
4. Open any Git repo and click the icon button in the Git panel

Settings

• gitgathom.language: zh | en
• gitgathom.provider: openai | deepseek | gemini | kimi | glm | custom
• gitgathom.model
• gitgathom.apiKey
• gitgathom.baseUrl
• gitgathom.customRequestPath (OpenAI defaults to /chat/completions; others default to empty)
• gitgathom.extraHeaders
• gitgathom.systemPrompt
• gitgathom.ruleTemplate
• gitgathom.additionalRules
• gitgathom.detailedOutput
• gitgathom.includeOnlyStaged
• gitgathom.maxChangedFiles
• gitgathom.truncateDiff
• gitgathom.maxDiffBytes (only works when truncateDiff=true)
• gitgathom.temperature
• gitgathom.maxTokens (null means no explicit limit)
• gitgathom.requestTimeoutMs
• gitgathom.commandTimeoutMs
• gitgathom.copyToClipboard
• gitgathom.debugView

AI Debug View

• When gitgathom.debugView is enabled, each generation opens a debug document
• The document includes system/user prompts, request headers/body, raw response, and parsed output
• Command GitFathom: Show Last AI Debug Report re-opens the latest report

Environment Variables

If gitgathom.apiKey is empty, GitFathom will check:

• OPENAI_API_KEY
• DEEPSEEK_API_KEY
• GEMINI_API_KEY
• MOONSHOT_API_KEY
• ZHIPU_API_KEY
• GITFATHOM_API_KEY