czg 1.4.2-beta.8 → 1.4.2-beta.9

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 +7 -3
  2. package/bin/index.js +138 -136
  3. 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 messages
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
- - ⚡️ **Lightweight** : Zero Dependencies (1.3MB)
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 messages
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,6 +75,7 @@ SYNOPSIS:
74
75
  czg [subcommand...] [options...] [git-commit-options...]
75
76
 
76
77
  SUBCOMMAND:
78
+ ai Turn on OpenAI generate subject mode
77
79
  break Turn on appends a ! after the type/scope
78
80
  emoji Turn on output message with emoji mode
79
81
  checkbox Turn on scope checkbox mode
@@ -81,6 +83,7 @@ SUBCOMMAND:
81
83
 
82
84
  OPTIONS:
83
85
  --config Specify the configuration file to use
86
+ -N=,--ai-num= Setting AI return number subjects and Turn on choose mode
84
87
  :, --alias Directly submit the defined commit message
85
88
  -r, --retry Directly retry submit by the last message
86
89
  -h, --help Show help
@@ -92,6 +95,7 @@ EXAMPLES:
92
95
  czg :fd
93
96
  czg --alias=fd
94
97
  czg --config="./config/cz.json"
98
+ czg ai -N=3
95
99
 
96
100
  Extends 'git commit' options.
97
101
  See 'git commit --help' for more information.