简介

czg 源于 commitizen/cz-cli 交互插件中 cz-git 的延伸项目，重新使用 TypeScript 编写的零依赖独立的 Node.js 命令行工具。旨在使用交互友好的方式，辅助用户生成规范的 git commit message 约定式提交。

首次用户

1. 使用 x env use czg 即可自动下载并使用

   • 在终端运行 eval "$(curl https://get.x-cmd.com)" 即可完成 x 命令安装, 详情参考 x-cmd 官网

2. x-cmd 提供1分钟教程，其中包含了 czg 命令常用功能的 demo 示例，可以帮你快速上手 czg 。

3. 使用案例:

   

   # 安装 czg
   x env use czg# 启用交互式生成 git commit
   czg# 开启 OpenAI 生成简短描述模式
   czg ai# 启动输出 message 中携带 emoji 表情模式
   czg emoji
   

功能特点

1. 轻量级：下载 czg 软件包不依赖任何第三方库，仅依赖 Node.js 标准库，体积小 (1.6MB)。无需额外下载或操作，开箱即用。
2. 交互友好：czg 的提供符合用户习惯的命令行的交互组件，如模糊搜索、多选框、补全输入等，旨在让用户减少重复输入，能快捷提交规范的提交信息。
3. 高度可定制化：czg 提供丰富的自定义配置，用户还可以编写JS配置文件，利用已有信息或获取信息进行动态配置，从而改变交互组件的交互方式，让工具更契合用户习惯和满足团队需求，在大型项目库如 Nx 和 Element UI Plus 等项目中得到广泛应用。
4. 多种提交模式：czg 可利用选项切换模式，例如在利用 AI 快捷生成简短描述、在 message 中嵌入 emoji 等等。

竞品和相关作品

1. Node.js - commitizen/cz-cli: 早期的的交互式辅助生成约定式提交的命令行工具，但需要搭配交互插件才能使用。
2. Python - commitizen：使用 Python 编写的交互式辅助生成约定式提交的命令行工具，此外该工具还提供校验提交信息，生成变更日志等功能。

进一步探索

• czg - 官网
• czg - 官网 - 配置模版
• czg - 官网 - 使用窍门示例
• czg - GitHub