LinuxCommandLibrary

git-cliff

TLDR

Generate changelog

$ git cliff
copy
Generate since tag
$ git cliff --tag [v1.0.0]
copy
Output to file
$ git cliff -o CHANGELOG.md
copy
Preview unreleased
$ git cliff --unreleased
copy
Custom config
$ git cliff --config [cliff.toml]
copy

SYNOPSIS

git cliff [options] [range]

DESCRIPTION

git cliff generates changelogs from git history using conventional commit conventions. It parses commit messages to categorize changes and produces formatted output.
The tool is highly configurable through TOML files, supporting custom templates, commit groups, and filtering. It integrates with CI/CD for automated release documentation.
git cliff produces professional changelogs from structured commit messages.

PARAMETERS

-o FILE, --output FILE

Output file.
--tag TAG
Process commits until tag.
--unreleased
Only process unreleased commits.
-c FILE, --config FILE
Configuration file.
--prepend FILE
Prepend to existing file.
--context
Print template context.
--help
Display help information.

CAVEATS

Works best with conventional commits. Requires configuration for custom formats. Template customization needs Tera syntax knowledge.

HISTORY

git cliff was created by Orhun Parmaksız as a highly customizable changelog generator, written in Rust for performance.

SEE ALSO

Copied to clipboard