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 许可证发布的。请随意根据您的需要修改和分发它。