czg 0.0.9 → 0.0.10

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.
Files changed (3) hide show
  1. package/README.md +7 -8
  2. package/bin/index.js +130 -132
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  WIP
6
6
 
7
7
  ```sh
8
- npx czg --help
8
+ $ npx czg --help
9
9
  NAME:
10
10
  czg - Interactive Commitizen CLI that generate standardized commit messages
11
11
 
@@ -13,28 +13,27 @@ WEBSITE:
13
13
  https://cz-git.qbenben.com/cli/
14
14
  https://github.com/Zhengqbbb/cz-git
15
15
 
16
- USAGE:
16
+ SYNOPSIS:
17
17
  czg [subcommand] [options]
18
18
 
19
19
  SUBCOMMAND:
20
- init Generate initialize commitizen configFile and guide
21
- Default porvide interactive prompt. skip 'czg init -y'
20
+ break Turn on BREAKING CHANGE mode, Add ! mark on header
22
21
  emoji Turn on emoji mode
23
22
  checkbox Turn on scope checkbox mode
24
- version Show version
25
- help Show help
26
23
 
27
24
  OPTIONS:
28
25
  --config Specify the configuration file to use
29
26
  --reback|-b Provide interactive prompt by the last message
30
27
  --retry|-r Direct retry submit by the last message
28
+ --help|-h Show help
29
+ --version Show version
31
30
 
32
31
  EXAMPLES:
33
32
  czg
34
33
  czg emoji
35
- czg --config "./config/cz.json"
34
+ czg --config="./config/cz.json"
36
35
 
37
- Run 'czg SUBCOMMAND --help' for more information on a command
36
+ Run 'czg SUBCOMMAND --help' for more information on a command.
38
37
  Extends 'git commit' command and options.
39
38
  See 'git commit --help' for more information.
40
39
  ```