Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.32 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.32 KB

Git Commit Generator(mini)

该脚本利用了 OpenAI 的 GPT-4o 模型来生成专业且简洁的 Git Commit 信息。

Quick Start

wget -O /usr/local/bin/cmm https://raw.githubusercontent.com/uk0/aicommit-shell/main/cmm.sh && chmod +x /usr/local/bin/cmm

功能

  • 根据 Git Diff 生成详细的 commit 信息
  • 使用 GPT-4o 生成的描述以帮助分析文件名以生成 commit 信息
  • 每个 commit 信息最长不超过 128 个字符，一次最多生成 5 条信息

使用方法

  1. 首先，需要在您的环境变量中设置 OPENAI_API_KEY，这是你从 OpenAI 平台获取的 API 密钥。

    export OPENAI_API_KEY=your-api-key

  2. 运行脚本。脚本会获取当前目录下的 Git 状态，然后发送请求到 OpenAI 平台，最后返回生成的 commit 信息。

     # 你可以将脚本放到 /usr/local/bin/cmm 
 # cp ./cmm.sh /usr/local/bin/cmm && chmod +x /usr/local/bin/cmm  
 # 在任意包含git管理的项目下使用 cmm
 ❯ cmm

注意事项

  • 确保在你的工作目录下运行该脚本，因为它会获取当前目录下的 Git 状态。
  • 脚本运行需要 jq 和 curl,vim。如果你的系统中没有这三个工具，需要先进行安装。
  • 该脚本目前只支持英文的文件名分析。