快速开始

「czg」需要 Node 版本 >=v12.20

全局使用

推荐: 相比 npm 脚本或者 npx 启动方式，Node.js 只需要启动一次，如此你使用 czg CLI 可以在任何项目以最快的速度启动

npm install -g czg

npm install -g czg

brew install czg

brew install czg

# https://cn.x-cmd.com/pkg/czg
# 适配 x-cmd theme 主题色 & 命令原生补全
x env use czg

# https://cn.x-cmd.com/pkg/czg
# 适配 x-cmd theme 主题色 & 命令原生补全
x env use czg

# 检查下载是否成功
czg --help
git czg -h

# 检查下载是否成功
czg --help
git czg -h

npm install -D czg

npm install -D czg

yarn add -D czg

yarn add -D czg

pnpm install -D czg

pnpm install -D czg

bun add -d czg

bun add -d czg

在 package.json 中添加启动脚本运行命令进行尝试 npm cz

json

{
  "scripts": {
    "cz": "czg"
  }
}

{
  "scripts": {
    "cz": "czg"
  }
}

你可以在任意项目下启动，但是 npx 启动速度会比全局安装慢

npx czg

npx czg

bunx czg

bunx czg

WARNING

不推荐这样使用

因为这样会改变 git commit 命令原有的行为，失去快速提交的方式
像 git commit -m "chore: ..."
但话虽如此，czg 依然支持，因为它可以约束限制你团队的提交行为

示例: husky(.husky/prepare-commit-msg)

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

exec < /dev/tty && npx czg --hook || true

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

exec < /dev/tty && npx czg --hook || true

在提交完消息后出现像 vim 的编辑器？ => 查看 FAQ 解决方案