Skip to content
On this page

czg

交互式命令行工具生成标准化的 git commit message

GitHub Repo starsawesome-cli-app
npmhomebrew


  • 轻量级 : 零依赖项 (1.3MB)
  • 简单且快速 : 无需前置配置,无需适配器,没有额外的步骤,你可以使用 npx | npm 脚本 | 全局下载... 在你的任何项目中快速启动
  • 可定制化 : 内部包含 cz-git 的核心,继承了 cz-git 的所有特性,具有相同的行为,配置加载... 你可以根据自己的需要配置的 CLI 的行为

demo

快速入门

  1. 你在你任何的项目中运行 npx czg
  2. 接下来让我们进行简单的配置,查看效果。创建 .czrc 在你的项目根路径中,然后运行相同的命令
json
{
  "scopes": [
    "hello",
    "world"
  ]
}
{
  "scopes": [
    "hello",
    "world"
  ]
}

TIP

关于配置文件以及配置项的更多信息,可查看 → 配置

特性以及帮助文档

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.

使用 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 ⭐