aicommitsとは？
aicommitsは、OpenAIのGPTモデルを活用してGitの変更内容に応じたコミットメッセージを自動生成するCLIツールです。このツールを使えば、AIがコード変更を分析し、適切なコミットメッセージを提案してくれます。これにより、エンジニアはコミットメッセージにかける時間を減らし、コードの品質向上に専念できるようになります。
インストール方法
1. Node.jsのインストール
aicommitsはNode.jsで動作するため、Node.js v14以上が必要です。Node.jsのバージョンは以下のコマンドで確認できます。
node --version
2. aicommitsのインストール
npmを使用して、aicommitsをグローバルにインストールします。
npm install -g aicommits
3. OpenAI APIキーの設定
aicommitsを利用するには、OpenAIのAPIキーが必要です。OpenAIの公式サイトからAPIキーを取得し、以下のコマンドで設定します。
aicommits config set OPENAI_KEY=<your-api-key>
基本的な使い方
1. ファイルをステージングしてコミットメッセージを生成
Gitに変更を追加した後、aicommitsを実行するだけでコミットメッセージを自動生成します。
git add <files...>
aicommits
2. コミットフラグの利用
aicommitsはGitのコミットフラグを受け取ることができます。たとえば、すべての変更を一度にステージングしてコミットするには以下のコマンドを使います。
aicommits --all # または -a
3. 複数のメッセージを生成
提案されたコミットメッセージが気に入らない場合、複数のメッセージを生成して選ぶことができます。
aicommits --generate 3 # または -g 3
4. Conventional Commitsに対応
プロジェクトでConventional Commitsの規約を採用している場合、コミットメッセージをその形式に合わせて生成できます。
aicommits --type conventional # または -t conventional
設定オプション
1. APIキーの設定と確認
設定されたAPIキーは次のコマンドで確認できます。
aicommits config get OPENAI_KEY
2. 生成するメッセージ数の設定
通常、aicommitsは1つのメッセージを生成しますが、設定で生成数を変更できます。
aicommits config set generate=3
3. メッセージの最大文字数
コミットメッセージの最大文字数はデフォルトで50文字ですが、設定で変更することが可能です。
aicommits config set max-length=100
参考