czg

Interactive Commitizen CLI that generate standardized git commit message

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

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

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

1{
2  "scopes": [
3    "hello",
4    "world"
5  ]
6}

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

Features and Help

1$ czg --help
2NAME:
3    czg - Interactive Commitizen CLI that generate standardized git commit message
4
5WEBSITE:
6    https://cz-git.qbb.sh/cli/
7    https://github.com/Zhengqbbb/cz-git
8
9SYNOPSIS:
10    czg [subcommand...] [options...] [git-commit-options...]
11
12SUBCOMMAND:
13    ai               Turn on OpenAI generate subject mode
14    break            Turn on appends a ! after the type/scope
15    emoji            Turn on output message with emoji mode
16    checkbox         Turn on scope checkbox mode
17    gpg              Turn on use GPG sign commit message
18
19OPTIONS:
20    :, --alias=      Directly submit the defined commit message
21    --config=        Specify the configuration file to use
22
23  OpenAI:
24    -N=,--ai-num=    Sets AI return multiple subjects and Turn on choose mode
25    -M=,--ai-model=  Sets AI model in this session
26                     [default: "gpt-4o-mini"]
27                     [example: "gpt-3.5-turbo", "gpt-4o", "gpt-4o-mini" ...]
28    --api-key=       Setup request OpenAI API secret key to local (.config/.czrc)
29    --api-model=     Setup request OpenAI API model      to local (.config/.czrc)
30    --api-proxy=     Setup request OpenAI API proxy      to local (.config/.czrc)
31    --api-endpoint=  Setup request OpenAI API endpoint   to local (.config/.czrc)
32                     [default: "https://api.openai.com/v1"]
33
34FLAG:
35    -r, --retry      Directly retry submit by the last message
36    --no-ai          Turn off AI prompt mode in this session
37    --unset-proxy    Unset request API proxy on local configure
38    -h, --help       Show help
39    -v, --version    Show version
40
41EXAMPLES:
42    czg
43    czg emoji
44    czg :fd
45    czg --config="./config/cz.json"
46    czg --api-key="sk-XXXXX"
47    czg ai -N=3 -M="gpt-4o"
48
49Extends 'git commit' options.
50See 'git commit --help' for more information.

Installation

「czg」 requires Node >=v12.20

1npm install -g czg

MacOS:

1brew install czg

⇒ Get Started (more installation and usage)

Configure

⇒ Configure Template

⇒ Show Related

⇒ Engineering Related

Recipes

⇒ Recipes

FAQ

⇒ FAQ

Projects using czg CLI

Nx

Element Plus

TDesign-Vue-Next

Vben-Admin

LICENSE

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

I just try my best to make thing well. Could you give a star ⭐ to encourage me 🤗 If possible, can to be my 💖 Sponsor 💖 to support my work