comsu

AI搭載の（ラッパー）メッセージジェネレーターをコミットします

comsuは、Googleの生成AIを活用して、GITの段階的な変更に基づいて高品質で簡潔なコミットメッセージを提案するシンプルでありながら強力なコマンドラインツールです。意味のあるコミットメッセージを書くプロセスを自動化し、プロジェクト全体で一貫性を確保します。

---

目次

• 特徴
• インストール
• 使用法
• 貢献
• あなたのサポートを見せてください

---

？特徴

• 自動化されたコミットメッセージ：GoogleのAIモデルを使用して、段階的な変更に基づいてコミットメッセージを生成します。
• 自動コミット：選択したコミットメッセージで変更を自動的にコミットできます。
• 従来のコミットタイプをサポートします。提案は、標準のコミットタイプ（ feat 、 fix 、 build 、 choreなど）に従います。
• 簡単なセットアップ：開始するための1コマンドのインストール。
• カスタマイズ可能なプロンプト：プロンプトファイルを変更して、特定のプロジェクトのニーズに合わせて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

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

Windows

これを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/share/git-comsu/promptにあるプロンプトという名前のファイルに保存されます。このファイルを変更して、AIがコミットメッセージを生成する方法を変更できます。

---

？貢献

貢献、問題、機能のリクエストは大歓迎です！問題のページを自由に確認してください。

1. リポジトリをフォークします。
2. 機能ブランチを作成します（git checkout -b feature/new -feature）。
3. 変更をコミットします（git commit -m '機能'を追加）。
4. ブランチにプッシュします（Git Push Origin Feature/New-Feature）。
5. プルリクエストを開きます。

---

？あなたのサポートを見せてください

このツールが役立つ場合は、リポジトリに提供してください！