dotninth / xenogit
您的即时 Git 提交消息的 CLI 伙伴。
Requires
- php: ^8.1
- guzzlehttp/guzzle: ^7.5
- illuminate/http: ^10.0
- laravel/prompts: ^0.1.3
- nunomaduro/termwind: ^1.15.1
Requires (Dev)
- laravel-zero/framework: ^10.0.2
- laravel/pint: ^1.11
- mockery/mockery: ^1.5.1
- pestphp/pest: ^2.5
- tightenco/duster: ^2.7
README
您的即时 Git 提交消息的 CLI 伙伴。
简介
Xenogit 是您的命令行助手，使用 OpenAI GPT 快速创建符合 Conventional Commit 规范的提交消息。停止花费时间编写提交，开始轻松管理您的 Git 仓库！
️开始使用
安装
安装 Xenogit 有两种方法
- 使用 Composer: 运行以下命令全局安装 Xenogit
composer global require dotninth/xenogit
- 从 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 密钥
-
使用命令
xenogit config:api-key <your-api-key>。 -
使用环境变量：创建一个名为
API_KEY的环境变量，其中包含您的 OpenAI API 密钥。 -
在 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 的 1/15。请确保您的 OpenAI 账户中有足够的资金或信用来支付 Xenogit 的使用费用。
有关使用 OpenAI 服务的价格信息，请查看他们的 OpenAI 定价页面。
贡献
欢迎您为 Xenogit 贡献！在为项目贡献时，请遵循以下指南以实现顺畅的合作
- 将存储库分叉并克隆到您的本地机器。
- 为您的贡献创建一个新的分支：
git checkout -b my-contribution。 - 进行更改，确保代码遵循项目的编码风格和规范。
- 彻底测试您的更改。
- 使用描述性的提交消息提交您的更改，遵循 Conventional Commit 规范。
- 将您的分支推送到您的分叉存储库： `git push origin my-contribution'。
- 向 Xenogit 存储库的 `main` 分支提交一个 pull request。
- 在 pull request 中提供您更改的清晰和详细描述，以及任何相关的信息或背景。
请注意，通过为 Xenogit 贡献，您同意根据 MIT 许可证 发布您的贡献。
许可证
Xenogit遵循MIT许可证发布。请随意根据您的需求对其进行修改和分发。