@@ -115,21 +115,22 @@ Read more in the section [Getting Started](./getting_started.md).
115
115
116
116
### Help
117
117
118
+ <!-- Please manually update the following section after changing `cz --help` command output. -->
119
+
118
120
``` sh
119
121
$ cz --help
120
- usage: cz [-h] [--debug] [-n NAME] [-nr NO_RAISE] {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...
122
+ usage: cz [-h] [--config CONFIG] [-- debug] [-n NAME] [-nr NO_RAISE] {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...
121
123
122
124
Commitizen is a cli tool to generate conventional commits.
123
- For more information about the topic, go to https://conventionalcommits.org/
125
+ For more information about the topic go to https://conventionalcommits.org/
124
126
125
- optional arguments :
127
+ options :
126
128
-h, --help show this help message and exit
127
- --config the path of configuration file
129
+ --config CONFIG the path of configuration file
128
130
--debug use debug mode
129
- -n NAME, --name NAME use the given commitizen (default: cz_conventional_commits)
130
- -nr NO_RAISE, --no-raise NO_RAISE
131
- comma separated error codes that won' t raise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-
132
- tools.github.io/commitizen/exit_codes/
131
+ -n, --name NAME use the given commitizen (default: cz_conventional_commits)
132
+ -nr, --no-raise NO_RAISE
133
+ comma separated error codes that won' t raise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/
133
134
134
135
commands:
135
136
{init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
0 commit comments