持续优化，构建更好地 auto git commit 体验

news2024/11/27 2:25:28

几个月前，受到一篇推文的启发 https://x.com/mtrainier2020/status/1802941902964277379 ，我突然想到可以借助 git alias 添加一些小命令，加速我的 git workflow 流程，于是我花了两个小时的时间进行工程封装，并发布了 pypi 包，并分享到了 V2EX 上： https://www.v2ex.com/t/1052254 。

几个月来，我一直在维护这个框架，gcop 是一个智能的 AI copilot ，旨在帮助开发者撰写更好的 git commit message ，同时加速 git workflow 。

官网： https://gcop.zeeland.top/

Github: https://github.com/undertone0809/gcop

gcop 具有以下优点：

配置简单，pip install gcop -U 之后，简单配置完自己的模型就能直接使用 AI 生成你的 commit
兼容市面上的几乎所有模型，底层基于promptulate 构建，开发者可以很轻松的配置自己想用的模型
加速 git workflow: 提供了丰富的 git 命令扩展，如 git amend, git info, git undo 等，用习惯了之后特别方便，具体参考 docs
自动撰写 git commit ，通过 git c 的命令就可以自动生成你的 git commit message ，十分方便。
自定义 commit 模板：支持最佳实践自定义模板，让 AI 学习定制化的 commit style 。

现在我一天基本会有好几个 commit，因此用 gcop 特别高频，每天都会用，有了 gcop 之后，感觉写 commit 的质量好了很多，commit message 也详细了很多，一定程度上增加了写代码的动力 xsl。

节选一些 commit message 供大家参考。

最近在设计一个功能：可以自动将一个大的 code diff 拆分多个 commit ，不知道大家有没有这个需求呢，另外大家要是有其他的建议也欢迎交流。

最后欢迎大家 star 支持一下！

快速上手

本指南将帮助您快速轻松地开始使用 GCOP (Git Copilot)，详情可以查看官网：https://gcop.zeeland.top

前置要求

在开始之前，请确保您已具备以下条件：

Python 3.8 或更新版本
系统中已安装 Git
您偏好的 LLM（如 OpenAI、Anthropic）的 API 密钥

安装

使用 pip 安装 GCOP：

pip install gcop

初始化 GCOP：

gcop init

此命令将设置 GCOP 并将其别名添加到您的 Git 配置中。

配置您的 AI 模型：

git gconfig

这将打开配置文件。编辑它以包含您的 AI 提供商详细信息：

model:
  model_name: provider/name, 例如 openai/gpt-4
  api_key: 您的api密钥

如何配置您的模型？请参考如何配置模型config.yaml 文件将存储在：

- <font style="color:rgb(0, 0, 0);">Windows: </font>`<font style="color:rgb(0, 0, 0);">%USERPROFILE%\.gcop\config.yaml</font>`
- <font style="color:rgb(0, 0, 0);">Linux: </font>`<font style="color:rgb(0, 0, 0);">~/.gcop/config.yaml</font>`
- <font style="color:rgb(0, 0, 0);">MacOS: </font>`<font style="color:rgb(0, 0, 0);">~/.gcop/config.yaml</font>`

验证安装：

git ghelp

您应该能看到可用的 GCOP 命令列表。

基本用法

生成 AI 提交信息

暂存您的更改：

git add .

生成并应用 AI 提交信息：

git c

有时，如果您想同时使用 git add . 和 git c，可以使用 git ac 作为快捷方式。

在 AI 生成提交信息后，您可以：

接受默认信息
重试
根据您的反馈重试
或退出

最终，您可以看到如下的提交信息：

(gcop) D:\Projects\gcop\docs>git ac
[Code diff] 
...


[Thought] 这些更改涉及更新 VitePress 配置以使用环境变量作为网站 ID，在快速入门指南中添加对新文档页面的引用，以及更正模型配置文档中的 URL。这些更改主要与文档和配置更新有关。
[Generated commit message]
docs: 更新 VitePress 配置并添加模型配置引用

- 更新 VitePress 配置以使用环境变量作为网站 ID
- 在快速入门文档中添加模型配置指南引用
- 更正模型配置文档中的 URL

这些更改提高了文档的清晰度和准确性，确保用户可以正确配置网站并了解如何设置模型。
? 您想用这个信息提交更改吗？ yes
[main 5612f60] docs: 更新 VitePress 配置并添加模型配置引用
 3 files changed, 5 insertions(+), 2 deletions(-)