Commit Crafter

安装

cargo install --locked commit_crafter

在 git 项目中安装 prepare-commit-msg 钩子并设置 OpenAI API 密钥以使用它。如果是首次安装和使用。

commit_crafter install

执行安装命令后，您必须首先设置一个密钥才能正常使用。

commit_crafter config set openai_api_key <your key>

选项

// openai api key
commit_crafter config set openai_api_key <your key>

// openai url
commit_crafter config set openai_url <your url>

// openai model
commit_crafter config set openai_model <your model>

// prompt language
commit_crafter config set user_language <your language>

// get config options
commit_crafter config get <option>

// get all config options
commit_crafter config list

语言列表

默认文件路径是 $HOME/.config/commit_crafter/config.toml

用法

正确安装钩子后，在 git 项目中执行 "git commit -a"。在打开的临时 Vim 编辑器界面中，将生成提交信息。前提是所有文件都已暂存待提交。

# prerequisites
git add . // or git add <file>

git commit -a

配置

待办事项

• 添加更多选项来自定义提交信息
• 支持更多 AI 模型
• 支持更多语言
• 添加更多测试
• 改进 README.md