czg

Interactive Commitizen CLI that generate standardized git commit message

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

🤖 OpenAI Support. Let the AI generate your git commit message description.
⚡️ Lightweight : Zero Dependencies (1.6MB)
🤗 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 git commit message

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

SYNOPSIS:
    czg [flag|options...] [git-commit-options...] [type list item search keywords]

FLAG:
    -r, --retry      Directly retry submit by the last message
    -a, --all        Automatically stage files that have been modified and deleted (Not new files)
    -b, --break      Turn on appends a ! after the type/scope
    -E, --emoji      Turn on output message with emoji mode
    -S, --gpg-sign   Turn on use GPG sign commit message
    -cb, --checkbox  Turn on scope checkbox mode
    -ai, --ai        Turn on OpenAI generate subject mode
    --no-ai          Turn off OpenAI prompt mode in this session
    --unset-proxy    Unset request API proxy on local configure
    -h, --help       Show help
    -v, --version    Show version

OPTIONS:
    :, --alias=      Directly submit the defined commit message
    --config=        Specify the configuration file to use

  OpenAI:
    -N=,--ai-num=    Setting AI return number subjects and Turn on choose mode
    --api-key=       Setup request OpenAI API secret key to local (.config/.czrc)
    --api-proxy=     Setup request OpenAI API proxy      to local (.config/.czrc)
    --api-endpoint=  Setup request OpenAI API endpoint   to local (.config/.czrc)
                     [default: "https://api.openai.com/v1"]

EXAMPLES:
    czg
    czg ch | czg ix
    czg -a -E
    czg :fd
    czg --config="./config/cz.json"
    czg --api-key="sk-XXXXX"
    czg -ai -N=3

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