cz-gitGetting Started
As global use
Recommend: Compared with the npm or npx startup method, Node.js can be started more directly once, that you to use the
czgCLI in any project at a faster speed
sh
npm install -g czg
npm install -g czg
sh
brew install czg
brew install czg
sh
# check the installation is successful
czg --help
git czg -h
# check the installation is successful
czg --help
git czg -h
As a dev dependency use
sh
npm install -D czg
npm install -D czg
sh
yarn add -D czg
yarn add -D czg
sh
pnpm install -D czg
pnpm install -D czg
sh
bun add -d czg
bun add -d czg
Add script in package.json try it npm cz
json
{
"scripts": {
"cz": "czg"
}
}
{
"scripts": {
"cz": "czg"
}
}
As npx use
You can start the CLI in different project, but the
npxstartup speed will be slower than global install
sh
npx czg
npx czg
sh
bunx czg
bunx czg
As git hooks use
WARNING
This is not recommended
- Because it will change the original behavior of git commit, so that will lose fast commit methods such as
git commit -m "xxx" - And it will eventually open
viso that will lose the convenience of using the CLI
Be that as it may czg still support, because it will constrain your team
e.g: husky(.husky/prepare-commit-msg)
sh
#!/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