czg

Interactive Commitizen CLI that generate standardized commit messages

Github | Installation | Website | 简体中文文档

Lightweight : Zero Dependencies (1.3MB)
Simpler and Faster : No plugin, No adapter, No extra steps, You can use npx | npm script | global install... quick start CLI in your any project
Highly Customizable : Internally contains the core of cz-git. Extend all the features of cz-git. Same behavior, Same configuration loader... You can customize the commit CLI according to your need

demo

Quick start

Now try it out, use npx czg in your any projects
And then, let's try to simply configure it. Create a .czrc file in the project root directory

{
  "scopes": [
    "hello",
    "world"
  ]
}

Note More information about configure file and options. See → Config

Features and Help

$ czg --help
NAME:
    czg - Interactive Commitizen CLI that generate standardized commit messages

WEBSITE:
    https://cz-git.qbenben.com/cli/
    https://github.com/Zhengqbbb/cz-git

SYNOPSIS:
    czg [subcommand] [options]

SUBCOMMAND:
    break          Turn on BREAKING CHANGE mode, Add ! mark on header
    emoji          Turn on output message with emoji mode
    checkbox       Turn on scope checkbox mode

OPTIONS:
    --config       Specify the configuration file to use
    :, --alias     Directly submit the defined commit message
    -r, --retry    Directly retry submit by the last message
    -h, --help     Show help
    -v, --version  Show version

EXAMPLES:
    czg
    czg emoji
    czg :ff
    czg --alias=ff
    czg --config="./config/cz.json"

Extends 'git commit' command and options.
See 'git commit --help' for more information.