このプロジェクトについて
AI Commitsは、選択したAIプロバイダーを使用して、ステージされた変更からGitコミットメッセージを生成するコマンドラインツールです。npmで配布されており、Node.js v22以降が必要です。
セットアップは、グローバルインストール(`npm install -g aicommits`)に続いて`aicommits setup`を実行することから始まります。このコマンドは、プロバイダーの選択、APIキーの設定、モデルの選択、および希望するコミットメッセージ形式を順に案内します。サポートされるプロバイダーには、TogetherAI、OpenAI、Groq、xAI、OpenRouter、Ollama(ローカル)、LM Studio(ローカル)、および任意のカスタムOpenAI互換エンドポイントが含まれます。設定は、CI/CDで使用するために`aicommits config set`を介して直接書き込むこともできます。
一般的な使用方法は、`git add`でファイルをステージし、`aicommits`を実行することです。不明なフラグは`git commit`に転送されます。主なCLIオプションには、追跡されている変更をステージする`--all`、コミットせずにメッセージをコピーする`--clipboard`、複数の候補メッセージを生成する`--generate`、分析からファイルを除外する`--exclude`、本文を追加する`--description`、形式を選択する`--type`、カスタム指示のための`--prompt`、フックをバイパスする`--no-verify`、確認をスキップする`--yes`があります。`aic`エイリアスも提供されています。
5つのコミットメッセージ形式が利用可能です:plain、conventional、conventional+body、gitmoji、subject+body。カスタムプロンプトで言語、トーン、焦点を調整できます。`prepare-commit-msg` Gitフックは`aicommits hook install`でインストールでき、通常の`git commit`呼び出しでメッセージが生成され、レビューのためにエディターで開かれます。
設定は、コマンドライン引数、環境変数、設定ファイル、デフォルトの順に解決されます。設定項目には、OPENAI_API_KEY、OPENAI_BASE_URL、OPENAI_MODEL、provider、locale、generate count、timeout、max-length、typeが含まれます。`aicommits config`、`aicommits config get`、`aicommits config set`、`aicommits model`、`aicommits update`などのコマンドで設定とアップグレードを管理します。
このツールはGitのステージされたスナップショットのみを読み取るため、ステージされていない編集はモデルに送信されません。READMEには、複数のメッセージを生成するとより多くのトークンを消費し、そのためコストが高くなることが記載されています。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.