Skip to main content

Initializing

The default configuration file (cliff.toml) can be generated using the --init flag:

# create cliff.toml
git cliff --init

There are also other templates under the examples directory. See the template examples for previewing the templates.

To initialize git-cliff with one of those templates, simply use the name of the template:

# create cliff.toml with Keep a Changelog format
git cliff --init keepachangelog

Also, you can use a template without creating the configuration file. Just give the name of the template to the --config option as follows:

# generate a changelog with using the built-in "detailed" template
git cliff --config detailed

Here are the list of available templates: