czg
Version:
Interactive Commitizen CLI that generate standardized git commit message
202 lines (161 loc) • 7.12 kB
Markdown
<h1 align="center">czg</h1>
<p align="center">
Interactive Commitizen CLI that generate standardized git commit message
</p>
<p align="center">
<a target="_blank" href="https://cz-git.qbb.sh/cli/">
<img style="display:inline-block;margin:0.2em;" alt="CLI-Link" src="https://img.shields.io/badge/Commitizen-CLI-red.svg?logo=git&style=flat">
</a>
<a target="_blank" href="https://github.com/agarrharr/awesome-cli-apps#git">
<img style="display:inline-block;margin:0.2em;" alt="awesome-cli-app" src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg">
</a>
<br/>
<a target="_blank" href="https://github.com/Zhengqbbb/cz-git">
<img style="display:inline-block;margin:0.2em;" alt="GitHub Repo stars" src="https://img.shields.io/github/stars/zhengqbbb/cz-git?style=social">
</a>
<br>
<a href="https://www.npmjs.com/package/czg">
<img style="display:inline-block;margin:0.2em;" alt="npm" src="https://img.shields.io/npm/v/czg?style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZD0iTTAgMGg0MHY0MEgwVjB6IiBmaWxsPSIjY2IwMDAwIi8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTcgN2gyNnYyNmgtN1YxNGgtNnYxOUg3eiIvPjwvc3ZnPgo=">
</a>
<a href="https://formulae.brew.sh/formula/czg">
<img style="display:inline-block;margin:0.2em;" alt="homebrew" src="https://img.shields.io/homebrew/v/czg?style=flat-square&logo=homebrew&label=homebrew">
</a>
</p>
<p align="center">
<a href="https://github.com/Zhengqbbb/cz-git">GitHub</a>
|
<a href="https://cz-git.qbb.sh/cli/install.html">Installation</a>
|
<a href="https://cz-git.qbb.sh/cli/">Website</a>
|
<a href="https://cz-git.qbb.sh/zh/cli/">简体中文文档</a>
</p>
<br/>
<br/>
- ⚡️ **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
```json
{
"scopes": [
"hello",
"world"
]
}
```
> **Note**
> More information about configure file and options. See → [Config](https://cz-git.qbb.sh/config/)
## Features and Help
```sh
$ 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
--config= Specify the configuration file to use
OpenAI:
-N=,--ai-num= Sets AI return multiple subjects and Turn on choose mode
-M=,--ai-model= Sets AI model in this session
[default: "gpt-4o-mini"]
[example: "gpt-3.5-turbo", "gpt-4o", "gpt-4o-mini" ...]
--api-key= Setup request OpenAI API secret key to local (.config/.czrc)
--api-model= Setup request OpenAI API model 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"]
FLAG:
-r, --retry Directly retry submit by the last message
--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 --api-key="sk-XXXXX"
czg ai -N=3 -M="gpt-4o"
Extends 'git commit' options.
See 'git commit --help' for more information.
```
## Installation
> 「czg」 requires Node >=**v12.20**
```sh
npm install -g czg
```
> MacOS:
```sh
brew install czg
```
[⇒ Get Started (more installation and usage)](https://cz-git.qbb.sh/cli/install.html)
## Configure
[⇒ Configure Template](https://cz-git.qbb.sh/config/)
[⇒ Show Related](https://cz-git.qbb.sh/config/show.html)
[⇒ Engineering Related](https://cz-git.qbb.sh/config/engineer.html)
## Recipes
[⇒ Recipes](https://cz-git.qbb.sh/recipes/)
## FAQ
[⇒ FAQ](https://cz-git.qbb.sh/faq/)
## Projects using czg CLI
<table>
<tr>
<td align="center" width="200px">
<a target="_blank" href="https://github.com/nrwl/nx">
<img src="https://user-images.githubusercontent.com/40693636/211251507-e45992b8-6e49-44e4-933c-100a68f5ff48.png" alt="Nx logo" width="40"><br>
<sub>Nx</sub>
</a>
</td>
<td align="center" width="200px">
<a target="_blank" href="https://github.com/element-plus/element-plus">
<img src="https://user-images.githubusercontent.com/40693636/172459748-939e3f1b-a694-4c09-b643-e1dce602105c.png" alt="Element Plus logo" width="40"><br>
<sub>Element Plus</sub>
</a>
</td>
<td align="center" width="200px">
<a target="_blank" href="https://github.com/Tencent/tdesign-vue-next">
<img src="https://user-images.githubusercontent.com/40693636/170830562-38e4c998-9af4-4303-9270-4f14e0942b08.png" alt="TDesign-Vue-Next logo" width="40"><br>
<sub>TDesign-Vue-Next</sub>
</a>
</td>
<td align="center" width="200px">
<a target="_blank" href="https://github.com/vbenjs/vue-vben-admin">
<img src="https://user-images.githubusercontent.com/40693636/178189964-931a1fc2-92df-4d04-8d0d-b748fc318c0a.png" alt="Vben-Admin logo" width="40"><br>
<sub>Vben-Admin</sub>
</a>
</td>
</tr>
</table>
## LICENSE
MIT Copyright (c) 2022-present Qiubin Zheng <zhengqbbb@gmail.com> (https://github.com/Zhengqbbb)
<p align="center">
<table>
<tbody>
<td align="center">
<br>
I just try my best to make thing well.<br>
Could you give a star ⭐ to encourage me 🤗
<br>
If possible, can to be my <a href="https://github.com/sponsors/Zhengqbbb">💖 Sponsor 💖</a> to support my work
<img width="800" height="0" />
</td>
</tbody>
</table>
</p>