Skip to main content

Getting Started

git-cliff can generate changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers.

The changelog template can be customized with a configuration file to match the desired format.

Quickstart​

  1. Install git-cliff:
cargo install git-cliff

Also, see the other installation options.

  1. Initialize git-cliff:
git-cliff --init

Edit the default configuration (cliff.toml) as you like. Check out the examples for different templates.

  1. Generate a changelog:
git-cliff -o CHANGELOG.md

See the command-line usage examples.

note

The git cliff command can also be used interchangeably with git-cliff (with a -) in most environments (when git is installed). However, when using the NPM installation method is used, the git-cliff command should be used.

Contribute​

Contributions are highly appreciated! See the contribution guidelines for getting started.

Feel free to submit issues and toss ideas!