|
77 | 77 | ```bash
|
78 | 78 | $ cz --help
|
79 | 79 | usage: cz [-h] [--debug] [-n NAME] [--version]
|
80 |
| - {ls,commit,c,example,info,schema,bump} ... |
| 80 | + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} |
| 81 | + ... |
81 | 82 |
|
82 | 83 | Commitizen is a cli tool to generate conventional commits.
|
83 | 84 | For more information about the topic go to https://conventionalcommits.org/
|
84 | 85 |
|
85 | 86 | optional arguments:
|
86 |
| --h, --help show this help message and exit |
87 |
| ---debug use debug mode |
88 |
| --n NAME, --name NAME use the given commitizen |
89 |
| ---version get the version of the installed commitizen |
| 87 | + -h, --help show this help message and exit |
| 88 | + --debug use debug mode |
| 89 | + -n NAME, --name NAME use the given commitizen (default: |
| 90 | + cz_conventional_commits) |
| 91 | + --version get the version of the installed commitizen |
90 | 92 |
|
91 | 93 | commands:
|
92 |
| -{ls,commit,c,example,info,schema,bump} |
93 |
| - ls show available commitizens |
| 94 | + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} |
| 95 | + init init commitizen configuration |
94 | 96 | commit (c) create new commit
|
| 97 | + ls show available commitizens |
95 | 98 | example show commit example
|
96 | 99 | info show information about the cz
|
97 | 100 | schema show commit schema
|
98 | 101 | bump bump semantic version based on the git log
|
| 102 | + changelog (ch) generate changelog (note that it will overwrite |
| 103 | + existing file) |
| 104 | + check validates that a commit message matches the commitizen |
| 105 | + schema |
99 | 106 | version get the version of the installed commitizen or the
|
100 | 107 | current project (default: installed commitizen)
|
101 |
| - check validates that a commit message matches the commitizen schema |
102 |
| - init init commitizen configuration |
103 | 108 | ```
|
104 | 109 |
|
105 | 110 | ## FAQ
|
|
0 commit comments