命令行模式

您可以aicommits直接调用为您的暂存更改生成提交消息：

git add <files...>
aicommits

aicommits将未知标志传递给git commit，因此您可以传入commit标志。

例如，您可以在提交时暂存跟踪文件中的所有更改：

aicommits --all # or -a

👉 提示：aic如果aicommits对您来说太长，请使用别名。

生成多个建议

有时推荐的提交消息不是最好的，因此您希望它生成一些以供选择。您可以通过传入标志一次生成多个提交消息--generate <i>，其中“i”是生成的消息数：

aicommits --generate <i> # or -g <i>

警告：这会使用更多的代币，这意味着它的成本更高。

生成常规提交

如果你想生成Conventional Commits，你可以使用--type标志后跟conventional。这将提示aicommits根据常规提交规范格式化提交消息：

aicommits --type conventional # or -t conventional

如果您的项目遵循常规提交标准，或者如果您使用依赖于此提交格式的工具，则此功能会很有用。

Git 钩子

您还可以通过挂钩将aicommits与 Git集成prepare-commit-msg。这使您可以像往常一样使用 Git，并在提交之前编辑提交消息。

安装

在要安装挂钩的 Git 存储库中：

aicommits hook install

卸载

在 Git 存储库中，您要从以下位置卸载挂钩：

aicommits hook uninstall

用法

1. 暂存文件并提交：

   git add <files...>
   git commit # Only generates a message when it's not passed in

   如果你想写自己的消息而不是生成消息，你可以简单地传递一个：git commit -m "My message"

2. Aicommits 将为您生成提交消息并将其传递回 Git。Git 将使用配置的编辑器打开它，供您查看/编辑它。

3. 保存并关闭编辑器以提交！

配置

读取配置值

要检索配置选项，请使用以下命令：

aicommits config get <key>

例如，要检索 API 密钥，您可以使用：

aicommits config get OPENAI_KEY

您还可以通过用空格分隔它们来一次检索多个配置选项：

aicommits config get OPENAI_KEY generate

设置配置值

要设置配置选项，请使用以下命令：

aicommits config set <key>=<value>

例如，要设置 API 密钥，您可以使用：

aicommits config set OPENAI_KEY=<your-api-key>

您还可以通过用空格分隔它们来一次设置多个配置选项，例如

aicommits config set OPENAI_KEY=<your-api-key> generate=3 locale=en

选项

OPENAI_KEY

必需的

OpenAI API 密钥。您可以从OpenAI API Keys 页面检索它。

语言环境

默认：en

用于生成的提交消息的语言环境。请参阅以下代码列表： https: //wikipedia.org/wiki/List_of_ISO_639-1_codes。

产生

默认：1

要生成以从中选择的提交消息数。

请注意，这将使用更多令牌，因为它会生成更多结果。

代理人

设置用于请求的 HTTP/HTTPS 代理。

要清除代理选项，可以使用命令（注意等号后的空值）：

aicommits config set proxy=

模型

默认：gpt-3.5-turbo

要使用的聊天完成 ( /v1/chat/completions) 模型。请查阅OpenAI 文档中可用的模型列表。

提示：如果您有访问权限，请尝试升级到gpt-4下一级代码分析。它可以处理双倍的输入大小，但成本更高。查看 OpenAI 的网站以了解更多信息。

暂停

以毫秒为单位的网络请求到 OpenAI API 的超时。

默认值：10000（10 秒）

aicommits config set timeout=20000 # 20s

最长长度

生成的提交消息的最大字符长度。

默认：50

aicommits config set max-length=100

类型

默认值：（""空字符串）

要生成的提交消息的类型。将其设置为“conventional”以生成遵循 Conventional Commits 规范的提交消息：

aicommits config set type=conventional

您可以通过将其设置为空字符串来清除此选项：

aicommits config set type=

怎么运行的

此 CLI 工具运行git diff以获取所有最新的代码更改，将它们发送到 OpenAI 的 GPT-3，然后返回 AI 生成的提交消息。

视频即将推出，我从头开始重建它，向您展示如何轻松构建您自己的由 AI 提供支持的 CLI 工具。