git-cliff

git cliff [options] [range]

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 Tera templates, commit groups, scope-based filtering, and conditional sections. It integrates with CI/CD pipelines for automated release documentation.git cliff supports conventional commits, Angular-style commits, and custom parsing rules, producing professional changelogs in Markdown, AsciiDoc, or custom template formats.

-o FILE, --output FILE

Output file.

Process commits until tag.

Only process unreleased commits.

Process commits starting from the latest tag.

Bump the version for the unreleased changes based on conventional commits.

Configuration file.

Run as if git-cliff was started in the given directory.

Prepend to existing file.

Print template context.

Generate a default configuration file.

Display help information.

cliff.toml

Configuration file defining commit parsing rules, grouping logic, filtering patterns, and output templates using Tera template syntax.

User-level default configuration for git-cliff settings.

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

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

git-changelog(1), git-log(1)

Source code · Homepage · Documentation