Skip to content
Changelog Generator

CLI

The changelog-generator can be run from the command line by running pnpx

Terminal window
# show the help
changelog-generator -h


# validate the changelog
changelog-generator --validate changelog.yml


# generate a markdown file
# The output is printed to the terminal, to save it pipe it to a file
changelog-generator -g markdown changelog.yml > changelog.md


# generate a rpm changelog
# The output is printed to the terminal, to save it pipe it to a file
changelog-generator --generator rpm --version 1.2.3 > changelog.rpm
# equivalent in shorthand flags
changelog-generator -g rpm -v 1.2.3 > changelog.rpm


# generate a debian changelog
# The output is printed to the terminal, to save it pipe it to a file
changelog-generator --generator debian --version 1.2.3 > changelog.debian
# equivalent in shorthand flags
changelog-generator -g debian -v 1.2.3 > changelog.debian