CommitAI

コミットAI

CommitAI は、git diff の出力に基づいてコミット メッセージを自動的に生成するコマンド ライン インターフェイス アプリケーションです。 OpenAI の GPT-3 API の機能を利用して、意味のある説明的なコミット メッセージを作成し、コードの変更を追跡しやすくします。 CommitAI を使用すると、時間を節約し、コミット メッセージを作成するのではなく、コードの作成に集中できます。

インストール

$ npm install --global commitai

または

$ yarn global add commitai

使用法

$ npx commitai [OPTIONS]

または

$ commitai [OPTIONS]

注: CommitAI を使用するには、有効な OpenAI API キーが必要です。 OpenAI API キーを 1 つ取得できます。 API キーを取得したら、それを環境変数として設定するか、CommitAI を使用する前に次のコマンドを実行する必要があります。

OPENAI_API_KEY=sk- < your-api-key > commitai

または、 .bashrcまたは.zshrcファイルの環境変数としてエクスポートします。

 export OPENAI_API_KEY=sk- < your-api-key > 

オプション

• -h, --help : ヘルプを表示します。
• -v, --version : バージョン番号を表示します
• -n [number], --numberOfCommitMessages [number] : 生成するコミットメッセージの数
• -e, --edit : コミットする前にコミットメッセージを編集します。
  • --no-e, --no-edit : コミットする前にコミットメッセージの編集を求めるプロンプトを表示しません。
• -c, --confirmation : コミットする前にコミットメッセージを確認します。
  • --no-c, --no-confirmation : コミットする前に確認を求めません。