xenogit

インスタント Git コミット メッセージの CLI の相棒。

導入

Xenogit 、OpenAI GPT を使用して従来のコミット仕様に準拠したコミット メッセージを迅速に作成する便利なコマンド ライン アシスタントです。コミットの作成に時間を費やすのはもうやめて、Git リポジトリの管理を楽に始めましょう。

️はじめに

インストール中

Xenogit をインストールするには 2 つの方法があります。

1. Composer の使用:次のコマンドを実行して、Xenogit をグローバルにインストールします。

composer global require dotninth/xenogit

2. GitHub からのダウンロード: GitHub のリリース ページにアクセスし、適切なバイナリをダウンロードします。

使用法

Xenogit をインストールした後、プログラムを起動するだけで、利用可能なすべてのオプションを利用できるようになります。

$ xenogit

  Xenogit  v1.3.2

  USAGE:  < command > [options] [arguments]

  commit         Automatically generate commit messages

  config:api-key Configure the API key in the .env file

APIキー

Xenogit が正しく動作するには、OpenAI からの API キーが必要です。 API キーを提供するには 2 つのオプションがあります。

1. コマンドxenogit config:api-key <your-api-key>を使用します。

2. 環境変数の使用: OpenAI API キーを含むAPI_KEYという環境変数を作成します。

3. Xenogit バイナリが配置されているディレクトリに.envという名前のファイルを作成します。このファイルは環境変数を保存するために使用されます。 .envファイルに次の行を追加し、 <YOUR_API_KEY>実際の OpenAI API キーに置き換えます。

API_KEY= < YOUR_API_KEY > 

支払い

Xenogit を使用すると、OpenAI API に対するリクエストごとに料金がかかります。 Xenogit は公式の ChatGPT ( gpt-3.5-turbo-16k ) モデルを使用しており、コストは GPT-4 の約 15 分の 1 です。 Xenogit の使用料を支払うのに十分な資金またはクレジットが OpenAI アカウントにあることを確認してください。

OpenAI のサービスの使用料金の詳細については、OpenAI の料金ページで料金ページを確認してください。

貢献する

ぜひ Xenogit に貢献してください。スムーズなコラボレーションのために、プロジェクトに貢献するときは次のガイドラインに従ってください。

1. リポジトリをフォークし、ローカル マシンにクローンを作成します。
2. コントリビューション用に新しいブランチを作成します: git checkout -b my-contribution 。
3. コードがプロジェクトのコーディング スタイルと規則に従っていることを確認して、変更を加えます。
4. 変更を徹底的にテストします。
5. 従来のコミット仕様に従って、説明的なコミット メッセージを使用して変更をコミットします。
6. 分岐したリポジトリにブランチをプッシュします: `git Pushorigin my-contribution'。
7. Xenogit リポジトリの「main」ブランチに対してプル リクエストを開きます。
8. 関連する情報やコンテキストとともに、プル リクエスト内の変更についての明確かつ詳細な説明を提供します。

Xenogit に貢献すると、MIT ライセンスに基づいて貢献をリリースすることに同意したことになることに注意してください。

ライセンス

Xenogit は MIT ライセンスに基づいてリリースされています。必要に応じて自由に変更して配布してください。