gcop:简化 Git 提交流程的高效助手 | 一键生成 commit message

  • 💖 大家好,我是Zeeland。Tags: 大模型创业、LangChain Top Contributor、算法工程师、Promptulate founder、Python开发者。
  • 📣 个人说明书:Zeeland
  • 📣 个人网站:me.zeeland.cn/
  • 📚 Github主页: Undertone0809 (Zeeland)
  • 🎉 支持我:点赞👍+收藏⭐️+留言📝 我会定期在博客、个人说明书、论坛中做一些技术分享。也欢迎大家阅读我的个人说明书,大家可以在这里快速了解我和我做过的事情,期待和你交个朋友,有机会我们一起做一些有意思的事情

在日常的开发工作中,提交代码是一项频繁且必须的任务。而编写一致且有意义的 git commit 消息对于项目的维护和代码审核至关重要。然而,这也是一项需要花费时间和精力的工作。为了简化这个过程,我开发了一个名为 gcop 的 Git 提交助手工具,只需一个命令就能自动生成合适的 git commit message。

开发背景

gcop 的开发灵感来自于一次偶然的推文分享 x.com/mtrainier20... git alias 添加一些小命令,于是我花了两个小时的时间进行工程封装,并发布了 pypi 包 ,so not only a demo。

我的目的很简单,就是简化自己的 git commit 流程。所有额外的操作或输入自然语言的步骤都会降低开发体验。因此,在这个核心场景下,我希望有一个工具可以无缝地集成到我的 git 工作流中,自动生成提交消息。

gcop 就是这样一个工具,它通过大语言模型的能力帮助我撰写 git commit 消息。只需要一个简单的命令 git gcommit,就能生成符合规范的提交消息,如 feat: ...。

在这个核心场景下,git gcommit 命令直接无缝接入我的 git 工作流中,让我可以非常方便地自动 commit。gcop 简单,但足够高效。

项目亮点

  1. 无缝集成到 Git 工作流: gcop 能让开发者在不需要额外输入任何自然语言的情况下,轻松生成合适的提交消息。只需一个 git gcommit 命令,即可完成。
  2. 集成大语言模型: gcop 集成了 promptulate 的能力,可以使用市面上的任意语言模型来生成 git commit message,如 gpt-4o、deepseek 等模型,用户可以通过配置文件(如 config.yaml)来选择和配置自己的模型,使用起来非常方便。
  3. 标准化的 Python 项目: gcop 是基于 p3g 脚手架生成的,确保了项目的标准化和可维护性。p3g 作为一个成熟的 Python 项目生成器,可以方便地创建标准化的 Python 工程化项目。

使用指南

安装和初始化

首先,通过 pip 安装 gcop:

shell 复制代码
pip install gcop

安装后需要初始化配置,运行以下命令:

shell 复制代码
gcop init

这将把 gcop 的命令别名添加到 git 中。

基本使用

在项目中执行以下命令以生成提交消息:

shell 复制代码
git add .
git gcommit

通过这些简单的操作,gcop 会根据阶段变更自动生成合适的提交消息。

配置语言模型

首次使用前需要配置语言模型。通过运行以下命令打开配置文件:

shell 复制代码
git gconfig

gcop 将生成一个 config.yaml 文件,用户可以在其中配置自己的语言模型。例如:

yaml 复制代码
model:
  model_name: OpenAI/gpt-4
  api_key: YOUR_API_KEY

视频演示

为了更清晰地展示 gcop 的功能,这里附上一个视频演示链接: www.youtube.com/watch?v=j7q...

如何自定义模型

gcop 集成了 promptulate 的能力,这意味着你可以轻松集成市面上的任意模型,下面的一些实例展示了如何配置不同大模型厂商的模型名。

下面是一个模型模版:

shell 复制代码
model:
  model_name: provider/name,eg openai/gpt-4o
  api_key: your_api_key

OpenAI

If you want to initialize the model, you can use the following command:

shell 复制代码
model:
  model_name: openai/gpt-4o
  api_key: your_api_key

Claude

shell 复制代码
model:
  model_name: claude-2
  api_key: your_api_key

Deepseek

shell 复制代码
model:
  model_name: deepseek/deepseek-chat
  api_key: your_api_key

Ollama

shell 复制代码
model:
  model_name: ollama/llama2
  api_key: your_api_key
  api_base: http://localhost:11434

OpenAI Proxy

如果你使用智谱的模型,这意味着你可以通过如下方式进行配置:

shell 复制代码
model:
  model_name: openai/glm-4
  api_key: your_api_key
  api_base: https://open.bigmodel.cn/api/paas/v4/

Use openai/model_name provider means you are using OpenAI SDK to call the model.

OpenRouter

shell 复制代码
model:
  model_name: openrouter/google/palm-2-chat-bison
  api_key: your_api_key

HuggingFace

shell 复制代码
model:
  model_name: huggingface/gpt2
  api_key: your_api_key

如何贡献

如果您对 gcop 感兴趣,可以访问 GitHub 项目页面获取更多信息和源码:github.com/Undertone08...

总结

在开发过程中,我深刻体会到简化工作流程的重要性。gcop 的诞生,就是为了让开发者能够更加专注于核心代码的编写,而不必被繁琐的提交消息所困扰。希望 gcop 能帮助更多的开发者提升工作效率。

当然,同步分享一下上面提到的两个项目,promptulate github.com/Undertone08... p3g 这两个框架也是本人开发。

相关推荐
IT_陈寒2 分钟前
React性能优化:这5个Hook技巧让我的组件渲染效率提升50%(附代码对比)
前端·人工智能·后端
Captaincc4 分钟前
9 月 20 日,TRAE Meetup@Guangzhou 相聚羊城
人工智能·后端
霍格沃兹软件测试开发19 分钟前
快速掌握Dify+Chrome MCP:打造网页操控AI助手
人工智能·chrome·dify·mcp
张子夜 iiii29 分钟前
4步OpenCV-----扫秒身份证号
人工智能·python·opencv·计算机视觉
华新嘉华DTC创新营销2 小时前
华新嘉华:AI搜索优化重塑本地生活行业:智能推荐正取代“关键词匹配”
人工智能·百度·生活
SmartBrain4 小时前
DeerFlow 实践:华为IPD流程的评审智能体设计
人工智能·语言模型·架构
l1t4 小时前
利用DeepSeek实现服务器客户端模式的DuckDB原型
服务器·c语言·数据库·人工智能·postgresql·协议·duckdb
寒月霜华5 小时前
机器学习-数据标注
人工智能·机器学习
九章云极AladdinEdu6 小时前
超参数自动化调优指南:Optuna vs. Ray Tune 对比评测
运维·人工智能·深度学习·ai·自动化·gpu算力
人工智能训练师7 小时前
Ubuntu22.04如何安装新版本的Node.js和npm
linux·运维·前端·人工智能·ubuntu·npm·node.js