grc (the Git Repository Committer)

基于大语言模型的 Git 提交信息生成工具。自动读取 Git 差异，调用 OpenAI 兼容 API 生成 Conventional Commits 格式的提交信息并执行提交。

特性

• 自动差异收集 — 自动检测暂存/未暂存的变更，合并为完整 diff 提交给 LLM
• 一站式配置 — 交互式初始化向导，配置持久化到 ~/.grc/config.json
• 中文提交信息 — 内置 Conventional Commits 中文 prompt，生成中文描述

使用示例

D:\path\to\repo> grc
暂存所有变更...
正在生成提交信息...

提交信息：
  docs(readme): 更新 README 文档结构和配置说明

- 移除环境变量配置方式，统一使用 config.json
- 简化配置优先级为单一配置源
- 调整默认端点为 https://api.openai.com/v1

提交成功！

D:\path\to\repo>

快速开始

# 安装
npm i -g git-repo-comitter

# 交互式配置
grc init

# 生成提交信息并提交
grc

源码安装

pnpm i
pnpm build
npm i -g .

本地开发：

pnpm build && node dist/index.cjs

使用

配置

所有配置通过 ~/.grc/config.json 管理，不再支持环境变量。

配置文件结构

{
  "endpoint": "https://api.openai.com/v1",
  "apiKey": "sk-xxx",
  "llm": {
    "model": "deepseek-v4-flash",
    "temperature": 0.7,
    "maxInputTokens": 262144,
    "maxOutputTokens": 16384
  }
}

交互式初始化

grc init

依次设置 API 地址、模型名称、API Key。配置保存到 ~/.grc/config.json。

提交信息风格

遵循 Conventional Commits 规范，中文描述。支持 feat、fix、refactor、docs 等类型，scope 可选，正文支持分条陈述。