Commit a2d0cb8

committed

docs(commit): document --write-message-to-file option

1 parent af8e276 commit a2d0cb8Copy full SHA for a2d0cb8

File tree

-0

lines changed

-0

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -6,6 +6,10 @@ In your terminal run `cz commit` or the shortcut `cz c` to generate a guided git
`6`	`6`
`7`	`7`	A commit can be signed off using `cz commit --signoff` or the shortcut `cz commit -s`.
`8`	`8`
	`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`	`+`
`9`	`13`	`!!! note`
`10`	`14`	To maintain platform compatibility, the `commit` command disable ANSI escaping in its output.
`11`	`15`	`In particular pre-commit hooks coloring will be deactivated as discussed in [commitizen-tools/commitizen#417](https://github.com/commitizen-tools/commitizen/issues/417).`

Comments

(0)