#commit #git-commit #changelog #commit-message #git #ChatGPT #log

app aichangelog

一个基于您的提交消息生成更改日志的 CLI 工具

1 个不稳定版本

0.1.0 2023 年 4 月 5 日

#64 in #changelog

MIT 许可协议

19KB
381

aichangelog

Crates.io Crates.io Crates.io

aichangelog 是一个用 Rust 编写的 CLI 工具,它根据您的 Git 提交消息生成更改日志。它利用 OpenAI 的对话模型来生成人类可读、Markdown 格式的更改日志。

安装

aichangelog 可以通过 Cargo(Rust 的包管理器)轻松安装。只需运行以下命令

cargo install aichangelog

请注意,为了使用 aichangelog,您需要设置 OPENAI_API_KEY 环境变量。此 API 密钥用于使用 OpenAI 语言模型,而 aichangelog 使用它来生成提交消息。

用法

使用 aichangelog 生成约定式提交

描述 默认
-s --short 仅使用提交消息的第一行以减少令牌
-t --temp AI 温度 0.0 - 2.0 1.0
-f --freq AI 频率惩罚 -2.0 - 2.0 0.0
-m --model 要使用的模型 gpt-3.5-turbo
-h --help 显示帮助信息
-V --version 显示版本

使用 aichangelog 获取帮助

要获取有关使用 aichangelog 的帮助,可以使用 -h--help 选项

$ aichangelog --help

这将显示有关如何使用该工具的帮助信息。

依赖项

~24–40MB
~453K SLoC