czg 1.8.1-beta.2 → 1.8.1-beta.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. package/README.md +16 -17
  2. package/lib/index.js +178 -177
  3. package/package.json +4 -5
package/README.md CHANGED
@@ -72,20 +72,14 @@ WEBSITE:
72
72
  https://github.com/Zhengqbbb/cz-git
73
73
 
74
74
  SYNOPSIS:
75
- czg [flag|options...] [git-commit-options...] [type list item search keywords]
75
+ czg [subcommand...] [options...] [git-commit-options...]
76
76
 
77
- FLAG:
78
- -r, --retry Directly retry submit by the last message
79
- -a, --all Automatically stage files that have been modified and deleted (Not new files)
80
- -b, --break Turn on appends a ! after the type/scope
81
- -E, --emoji Turn on output message with emoji mode
82
- -S, --gpg-sign Turn on use GPG sign commit message
83
- -cb, --checkbox Turn on scope checkbox mode
84
- -ai, --ai Turn on OpenAI generate subject mode
85
- --no-ai Turn off OpenAI prompt mode in this session
86
- --unset-proxy Unset request API proxy on local configure
87
- -h, --help Show help
88
- -v, --version Show version
77
+ SUBCOMMAND:
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
89
83
 
90
84
  OPTIONS:
91
85
  :, --alias= Directly submit the defined commit message
@@ -96,16 +90,21 @@ OPTIONS:
96
90
  --api-key= Setup request OpenAI API secret key to local (.config/.czrc)
97
91
  --api-proxy= Setup request OpenAI API proxy to local (.config/.czrc)
98
92
  --api-endpoint= Setup request OpenAI API endpoint to local (.config/.czrc)
99
- [default: "https://api.openai.com/v1"]
93
+
94
+ FLAG:
95
+ -r, --retry Directly retry submit by the last message
96
+ --no-ai Turn off AI prompt mode in this session
97
+ --unset-proxy Unset request API proxy on local configure
98
+ -h, --help Show help
99
+ -v, --version Show version
100
100
 
101
101
  EXAMPLES:
102
102
  czg
103
- czg ch | czg ix
104
- czg -a -E
103
+ czg emoji
105
104
  czg :fd
106
105
  czg --config="./config/cz.json"
107
106
  czg --api-key="sk-XXXXX"
108
- czg -ai -N=3
107
+ czg ai -N=3
109
108
 
110
109
  Extends 'git commit' options.
111
110
  See 'git commit --help' for more information.