Skip to content

Commit a2d0cb8

Browse files
committed
docs(commit): document --write-message-to-file option
1 parent af8e276 commit a2d0cb8

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/commit.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ In your terminal run `cz commit` or the shortcut `cz c` to generate a guided git
66

77
A commit can be signed off using `cz commit --signoff` or the shortcut `cz commit -s`.
88

9+
You can run `cz commit --write-message-to-file COMMIT_MSG_FILE` to additionally save the
10+
generated message to a file. This can be combined with the `--dry-run` flag to only
11+
write the message to a file and not modify files and create a commit.
12+
913
!!! note
1014
To maintain platform compatibility, the `commit` command disable ANSI escaping in its output.
1115
In particular pre-commit hooks coloring will be deactivated as discussed in [commitizen-tools/commitizen#417](https://github.com/commitizen-tools/commitizen/issues/417).

0 commit comments

Comments
 (0)