Skip to content
On this page

czg

Interactive Commitizen CLI that generate standardized commit messages

GitHub Repo starsawesome-cli-app
npmhomebrew


  • 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

  1. Now try it out, use npx czg in your any projects
  2. And then, let's try to simply configure it. Create a .czrc file in the project root directory
json
{
  "scopes": [
    "hello",
    "world"
  ]
}
{
  "scopes": [
    "hello",
    "world"
  ]
}

TIP

More information about configure file and options. See → Config

Features and Help

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

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

SYNOPSIS:
    czg [subcommand...] [options...] [git-commit-options...]

SUBCOMMAND:
    break          Turn on appends a ! after the type/scope
    emoji          Turn on output message with emoji mode
    checkbox       Turn on scope checkbox mode
    gpg            Turn on use GPG sign commit message

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 :fd
    czg --alias=fd
    czg --config="./config/cz.json"

Extends 'git commit' options.
See 'git commit --help' for more information.
$ czg --help
NAME:
    czg - Interactive Commitizen CLI that generate standardized commit messages

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

SYNOPSIS:
    czg [subcommand...] [options...] [git-commit-options...]

SUBCOMMAND:
    break          Turn on appends a ! after the type/scope
    emoji          Turn on output message with emoji mode
    checkbox       Turn on scope checkbox mode
    gpg            Turn on use GPG sign commit message

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 :fd
    czg --alias=fd
    czg --config="./config/cz.json"

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

Projects using czg CLI

Element Plus logoElement PlusTDesign-Vue-Next logoTDesign-Vue-NextVben-Admin logoVben-AdminVue3-Antd-Admin logoVue3-Antd-Admin

LICENSE

MIT Copyright (c) 2022-present Qiubin Zheng zhengqbbb@gmail.com (https://github.com/Zhengqbbb)

I just do my best to make thing well, Could you give a star ⭐ to encourage me ?

I just try my best to make thing well, Could you give a star ⭐