Create Git Push Docs 是一个使用大型语言模型(LLM)从暂存变更中自动生成 commit 信息和详细变更文档的小工具。它具有以下功能特性:

  • 根据 git diff --staged 自动生成简洁的 commit 信息
  • 生成详细的 Markdown 格式变更文档
  • 支持配置文件和环境变量两种配置方式
  • 兼容 OpenAI API 及所有兼容接口
  • 支持多语言输出(English / 简体中文)
  • LLM 请求时显示实时进度

项目地址:GitHub - WangShayne/cgpd

使用方法:

生成 Commit 信息(默认)

git add .
cgpd
# 输出:添加用户认证功能,使用 JWT 令牌

# 直接用于 git commit
git commit -m "$(cgpd)"

生成变更文档

cgpd --docs
# 输出:docs/history/2025-12-26-143052.md

命令行选项

Usage:
  cgpd [flags]

Flags:
    --docs      生成详细的 Markdown 变更文档
  -h, --help      显示帮助信息
  -v, --version   显示版本信息

工作流示例:

日常开发

git add .
git commit -m "$(cgpd)"
git push

版本发布

git add .
cgpd --docs
git add docs/history/
git commit -m "$(cgpd)"
git tag v1.0.0
git push --tags

Git Hooks 集成
创建 .git/hooks/prepare-commit-msg

#!/bin/bash
if [ -z "$(cat $1)" ]; then
  cgpd > $1
fi
chmod +x .git/hooks/prepare-commit-msg

更多详情请参考:[ - 最新话题]1371342)

标签: none

评论已关闭