xenogit

您的 CLI 夥伴，可取得即時 Git 提交訊息。

介紹

Xenogit是您有用的命令列助手，它使用 OpenAI GPT 快速建立遵循常規提交規範的提交訊息。停止花時間編寫提交並開始輕鬆管理您的 Git 儲存庫！

️開始使用

安裝中

有兩種方法安裝Xenogit：

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 金鑰的選項：

1. 使用指令xenogit config:api-key <your-api-key> 。

2. 使用環境變數：建立一個名為API_KEY的環境變量，其中包含您的 OpenAI API 金鑰。

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 倍。確保您的 OpenAI 帳戶中有足夠的資金或積分來支付 Xenogit 的使用費用。

要了解有關使用 OpenAI 服務的價格的更多信息，請在 OpenAI 定價頁面查看其定價頁面。

貢獻

歡迎您為 Xenogit 做出貢獻！為了順利合作，請在為專案做出貢獻時遵循以下準則：

1. 分叉存儲庫並將其克隆到本機。
2. 為您的貢獻建立一個新分支： git checkout -b my-contribution 。
3. 進行更改，確保程式碼遵循專案的編碼風格和約定。
4. 徹底測試您的變更。
5. 遵循常規提交規範，使用描述性提交訊息提交更改。
6. 將您的分支推送到分叉儲存庫：「git push origin my-contribution」。
7. 針對 Xenogit 儲存庫的「main」分支開啟拉取請求。
8. 提供對拉取請求中的變更的清晰詳細的描述，以及任何相關資訊或上下文。

請注意，透過向 Xenogit 做出貢獻，您同意根據 MIT 許可證發布您的貢獻。

執照

Xenogit 是根據 MIT 許可證發布的。請隨意根據您的需求修改和分發它。