Getting Started ​

「czg」 requires Node >=v12.20

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 czg CLI in any project at a faster speed

npm install -g czg

npm install -g czg

brew install czg

brew install czg

# https://x-cmd.com/pkg/czg
# Adapt `x-cmd theme` colorizen & command native completion
x env use czg

# https://x-cmd.com/pkg/czg
# Adapt `x-cmd theme` colorizen & command native completion
x env use czg

# 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 ​

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

Add script in package.json try it npm cz

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

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

As npx use ​

You can start the CLI in different project, but the npx startup speed will be slower than global install

npx czg

npx czg

bunx czg

bunx czg

As git hooks use ​

e.g: 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

Opening a like vim editor after submitting the message ? ==> See FAQ for solution