Skip to content

Commit 5ae9058

Browse files
committed
docs(README): add changelog command
1 parent 384018d commit 5ae9058

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,29 +77,34 @@ cz c
7777
```bash
7878
$ cz --help
7979
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+
...
8182

8283
Commitizen is a cli tool to generate conventional commits.
8384
For more information about the topic go to https://conventionalcommits.org/
8485

8586
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
9092

9193
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
9496
commit (c) create new commit
97+
ls show available commitizens
9598
example show commit example
9699
info show information about the cz
97100
schema show commit schema
98101
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
99106
version get the version of the installed commitizen or the
100107
current project (default: installed commitizen)
101-
check validates that a commit message matches the commitizen schema
102-
init init commitizen configuration
103108
```
104109

105110
## FAQ

0 commit comments

Comments
 (0)