Skip to content

Commit f8b4901

Browse files
committed
docs(README.md): sync help section with the latest cz --help command output
1 parent 4c1d1a1 commit f8b4901

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -115,21 +115,22 @@ Read more in the section [Getting Started](./getting_started.md).
115115

116116
### Help
117117

118+
<!-- Please manually update the following section after changing `cz --help` command output. -->
119+
118120
```sh
119121
$ 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} ...
121123

122124
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/
124126

125-
optional arguments:
127+
options:
126128
-h, --help show this help message and exit
127-
--config the path of configuration file
129+
--config CONFIG the path of configuration file
128130
--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/
133134
134135
commands:
135136
{init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}

0 commit comments

Comments
 (0)