czg 1.4.2-beta.8 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -13
- package/bin/index.js +137 -136
- package/package.json +5 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<h1 align="center">czg</h1>
|
|
2
2
|
|
|
3
|
-
> Interactive Commitizen CLI that generate standardized commit
|
|
3
|
+
> Interactive Commitizen CLI that generate standardized git commit message
|
|
4
4
|
|
|
5
5
|
<p align="center">
|
|
6
6
|
<a target="_blank" href="https://cz-git.qbb.sh/cli/">
|
|
@@ -35,7 +35,8 @@
|
|
|
35
35
|
<br/>
|
|
36
36
|
<br/>
|
|
37
37
|
|
|
38
|
-
-
|
|
38
|
+
- 🤖 **OpenAI Support.** Let the AI generate your git commit message description.
|
|
39
|
+
- ⚡️ **Lightweight** : Zero Dependencies (1.5MB)
|
|
39
40
|
- 🤗 **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
|
|
40
41
|
- 😎 **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
|
|
41
42
|
|
|
@@ -64,7 +65,7 @@ Create a `.czrc` file in the project root directory
|
|
|
64
65
|
```sh
|
|
65
66
|
$ czg --help
|
|
66
67
|
NAME:
|
|
67
|
-
czg - Interactive Commitizen CLI that generate standardized commit
|
|
68
|
+
czg - Interactive Commitizen CLI that generate standardized git commit message
|
|
68
69
|
|
|
69
70
|
WEBSITE:
|
|
70
71
|
https://cz-git.qbb.sh/cli/
|
|
@@ -74,24 +75,28 @@ SYNOPSIS:
|
|
|
74
75
|
czg [subcommand...] [options...] [git-commit-options...]
|
|
75
76
|
|
|
76
77
|
SUBCOMMAND:
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
78
|
+
ai Turn on OpenAI generate subject mode
|
|
79
|
+
break Turn on appends a ! after the type/scope
|
|
80
|
+
emoji Turn on output message with emoji mode
|
|
81
|
+
checkbox Turn on scope checkbox mode
|
|
82
|
+
gpg Turn on use GPG sign commit message
|
|
81
83
|
|
|
82
84
|
OPTIONS:
|
|
83
|
-
--config
|
|
84
|
-
|
|
85
|
-
-
|
|
86
|
-
|
|
87
|
-
-
|
|
85
|
+
--config= Specify the configuration file to use
|
|
86
|
+
--openai-token= Setup OpenAI API secret key to local (.config/.czrc)
|
|
87
|
+
-N=,--ai-num= Setting AI return number subjects and Turn on choose mode
|
|
88
|
+
:, --alias Directly submit the defined commit message
|
|
89
|
+
-r, --retry Directly retry submit by the last message
|
|
90
|
+
-h, --help Show help
|
|
91
|
+
-v, --version Show version
|
|
88
92
|
|
|
89
93
|
EXAMPLES:
|
|
90
94
|
czg
|
|
91
95
|
czg emoji
|
|
92
96
|
czg :fd
|
|
93
|
-
czg --alias=fd
|
|
94
97
|
czg --config="./config/cz.json"
|
|
98
|
+
czg --openai-token="sk-XXXXX"
|
|
99
|
+
czg ai -N=3
|
|
95
100
|
|
|
96
101
|
Extends 'git commit' options.
|
|
97
102
|
See 'git commit --help' for more information.
|