git-cliff

Generates changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers.

Runs as git-cliff|macOS, Linux, Windows|git-cliff.org

Open form in Otty otty.toml

Command form

ai-draft · 3 tasks · 13 fields

Generate a changelog from git history with git-cliff. Commit-parser, template and remote-integration options are left out.

Opens the form; the finished command lands at your prompt, unrun

Run in Otty

otty gui git-cliff

Generate changelogExample values, fixed in this page — nothing here reaches a terminal

Basic

Unreleased only

--unreleased

Tag for unreleased

string

Output file

file

Advanced

Config file

file

Prepend to file

file

TasksEach one presets the form for one job

Unreleased changes

unreleasedtagoutputprependconfig

Latest release

latestoutputconfig

Full changelog

rangeoutputconfigsort

ParametersOnly these flags are editable in the form

Commit range

A git revision range such as v1.0.0..HEAD. Leave empty to process the whole history.
string · positional 0

Unreleased only

Process only commits that do not belong to a tag.
boolean

--unreleased-u

Latest tag only

Process commits starting from the latest tag.
boolean

--latest-l

Current tag only

Process the commits that belong to the current tag.
boolean

--current

Tag for unreleased

Version label to use for the unreleased commits.
string

--tag-t

Output file

Write the changelog to this file instead of the terminal.
path

--output-o

Prepend to file

Prepend the new entries to an existing changelog file.
path

--prepend-p

Config file

Defaults to cliff.toml.
path

--config-c

Repository

Git repository to read.
path

--repository-r

Strip part

string

--strip-sheaderfooterall

Commit sorting

string

--sortoldestnewest

Write default cliff.toml

Create a default configuration file instead of a changelog.
boolean

--init-i

Verbosity

Repeat for more detail.
count

--verbose-v

SourcesEvery flag above is checked against these

fig

completion

github.com

Before it fills your prompt, Otty checks the installed git-cliff against its version. A form that does not match your version is not offered.