CommitAI
1.0.0
CommitAI 是一个命令行界面应用程序,可根据 git diff 的输出自动生成提交消息。它利用 OpenAI 的 GPT-3 API 的强大功能来创建有意义的描述性提交消息,从而更轻松地跟踪代码更改。借助 CommitAI,您可以节省时间并专注于编写代码,而不是精心制作提交消息。
$ npm install --global commitai
或者
$ yarn global add commitai
$ npx commitai [OPTIONS]
或者
$ commitai [OPTIONS]
注意:您必须拥有有效的 OpenAI API 密钥才能使用 CommitAI。您可以获得一个 OpenAI API 密钥。获得 API 密钥后,必须将其设置为环境变量,或者必须在使用 CommitAI 之前运行以下命令:
OPENAI_API_KEY=sk- < your-api-key > commitai
或将其导出为.bashrc
或.zshrc
文件中的环境变量:
export OPENAI_API_KEY=sk- < your-api-key >
-h, --help
: 显示帮助-v, --version
: 显示版本号-n [number], --numberOfCommitMessages [number]
:要生成的提交消息数-e, --edit
: 在提交之前编辑提交消息--no-e, --no-edit
: 提交前不提示编辑提交消息-c, --confirmation
: 提交前确认提交消息--no-c, --no-confirmation
: 提交前不提示确认