czg

Interactive CLI that generate standardized git commit messages

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

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

json

{
  "$schema": "https://cdn.jsdelivr.net/gh/Zhengqbbb/cz-git@1.6.1/docs/public/schema/cz-git.json",
  "scopes": [
    "hello",
    "world"
  ]
}

{
  "$schema": "https://cdn.jsdelivr.net/gh/Zhengqbbb/cz-git@1.6.1/docs/public/schema/cz-git.json",
  "scopes": [
    "hello",
    "world"
  ]
}

TIP

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 [subcommand...] [options...] [git-commit-options...]

SUBCOMMAND:
    ai               Turn on OpenAI generate subject mode
    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:
    :, --alias       Directly submit the defined commit message
    -r, --retry      Directly retry submit by the last message
    --config=        Specify the configuration file to use
    --openai-token=  Setup OpenAI API secret key to local (.config/.czrc)
    --api-proxy=     Setup request OpenAI API proxy to local (.config/.czrc)
    -N=,--ai-num=    Setting AI return number subjects and Turn on choose mode
    --no-ai          Turn off AI prompt mode in this session
    --unset-proxy    Unset request API proxy on local configure
    -h, --help       Show help
    -v, --version    Show version

EXAMPLES:
    czg
    czg emoji
    czg :fd
    czg --config="./config/cz.json"
    czg --openai-token="sk-XXXXX"
    czg ai -N=3

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

$ 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 [subcommand...] [options...] [git-commit-options...]

SUBCOMMAND:
    ai               Turn on OpenAI generate subject mode
    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:
    :, --alias       Directly submit the defined commit message
    -r, --retry      Directly retry submit by the last message
    --config=        Specify the configuration file to use
    --openai-token=  Setup OpenAI API secret key to local (.config/.czrc)
    --api-proxy=     Setup request OpenAI API proxy to local (.config/.czrc)
    -N=,--ai-num=    Setting AI return number subjects and Turn on choose mode
    --no-ai          Turn off AI prompt mode in this session
    --unset-proxy    Unset request API proxy on local configure
    -h, --help       Show help
    -v, --version    Show version

EXAMPLES:
    czg
    czg emoji
    czg :fd
    czg --config="./config/cz.json"
    czg --openai-token="sk-XXXXX"
    czg ai -N=3

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