comsu

AI驱动（包装）提交消息生成器

COMSU是一种简单而功能强大的命令行工具，它利用Google Generative AI根据您的GIT上演更改建议高质量，简洁的提交消息。自动化编写有意义的提交消息的过程并确保您的项目一致性。

---

目录

• 特征
• 安装
• 用法
• 贡献
• 表示您的支持

---

？特征

• 自动提交消息：使用Google的AI模型根据您的分阶段更改生成提交消息。
• 自动提交：它可以通过所选的提交消息自动提交您的更改。
• 支持常规提交类型：建议遵循标准提交类型（ feat ， fix ， build ， chore等）。
• 轻松设置：开始安装。
• 可自定义的提示：修改提示文件，以根据您的特定项目需求量身定制AI建议。

---

？安装

Linux

要在Linux系统上设置COMSU ，请按照以下步骤：

1. 克隆存储库：

   git clone https://github.com/ali-hv/comsu.git
   cd comsu

2. 运行安装脚本：

   chmod +x install.sh
   sudo ./install.sh

3. 设置您的API密钥：

   确保您将Google AI Studio API密钥集作为环境变量。如果您没有一个，则可以在此处创建一个免费的API键。

    export GOOGLE_AI_STUDIO_API_KEY= " your_api_key_here "

   您可以将此行添加到您的~/.bashrc或~/.zshrc中，以使其持久。

视窗

要在Windows系统上设置COMSU ，请按照以下步骤：

1. 克隆存储库：打开PowerShell作为管理员，然后编写以下命令：

   git clone https: // github.com / ali - hv / comsu.git
   cd comsu

2. 运行安装脚本：

   powershell - ExecutionPolicy Bypass - File install.ps1

3. 设置您的API密钥：

   确保您将Google AI Studio API密钥集作为环境变量。如果您没有一个，则可以在此处创建一个免费的API键。

   set GOOGLE_AI_STUDIO_API_KEY = your_api_key_here

   您可以将此行添加到$路径中以使其持久。

---

用法

安装后，您可以从上演更改的任何目录中运行COMSU ：

Linux

git comsu

视窗

在CMD中运行此操作：

git-comsu

如果您居住在受Google限制的国家 /地区，则可能需要使用VPN或更改DNS。

这将根据您的更改生成建议的提交消息的列表，您可以选择所需的消息，然后它将自动使用该消息提交更改。如果您不喜欢任何消息，则可以输入“ X”退出。

例子

git add .
git comsu

输出：

 Generating the commit messages based on your changes ...

1. ref: Refactor the send_email function for efficiency
2. ref: Update the send_email to reduce processing time
3. feat: Use new method for getting the changes in send_email

Write the message number you want to use (write 'x' to exit): 1

[main 6b25961] ref: Refactor the send_email function for efficiency
 1 file changed, 1 deletion(-)

Committed successfully.

---

配置

用于生成该提交消息的提示存储在位于/usr/local/local/share/git-comsu/提示的名为提示的文件中。您可以修改此文件以更改AI生成提交消息的方式。

---

？贡献

欢迎贡献，问题和功能请求！随时检查问题页面。

1. 分叉存储库。
2. 创建您的功能分支（git Checkout -B功能/新功能）。
3. 提交您的更改（git commit -m'添加一些功能'）。
4. 推到分支（git推出原点功能/新功能）。
5. 打开拉动请求。

---

？表示您的支持

如果您发现此工具很有帮助，请给予存储库！