git-cliff(1)                General Commands Manual               git-cliff(1)

NAME
       git-cliff - A highly customizable changelog generator <?><?>

SYNOPSIS
       git-cliff [-h|--help] [-V|--version] [-v|--verbose]... [-i|--init]
       [-c|--config] [-w|--workdir] [-r|--repository] [--include-path]
       [--exclude-path] [--tag-pattern] [--with-commit] [--skip-commit]
       [-p|--prepend] [-o|--output] [-t|--tag] [--bump] [--bumped-version]
       [-b|--body] [-l|--latest] [--current] [-u|--unreleased] [--topo-order]
       [--no-exec] [-x|--context] [-s|--strip] [--sort] [--github-token]
       [--github-repo] [RANGE]

DESCRIPTION
       A highly customizable changelog generator <?><?>

OPTIONS
       -h, --help
              Prints help information

       -V, --version
              Prints version information

       -v, --verbose
              Increases the logging verbosity

       -i, --init=CONFIG
              Writes the default configuration file to cliff.toml

       -c, --config=PATH [default: cliff.toml]
              Sets the configuration file
              May also be specified with the GIT_CLIFF_CONFIG environment
              variable.

       -w, --workdir=PATH
              Sets the working directory
              May also be specified with the GIT_CLIFF_WORKDIR environment
              variable.

       -r, --repository=PATH
              Sets the git repository
              May also be specified with the GIT_CLIFF_REPOSITORY environment
              variable.

       --include-path=PATTERN
              Sets the path to include related commits
              May also be specified with the GIT_CLIFF_INCLUDE_PATH
              environment variable.

       --exclude-path=PATTERN
              Sets the path to exclude related commits
              May also be specified with the GIT_CLIFF_EXCLUDE_PATH
              environment variable.

       --tag-pattern=PATTERN
              Sets the regex for matching git tags
              May also be specified with the GIT_CLIFF_TAG_PATTERN environment
              variable.

       --with-commit=MSG
              Sets custom commit messages to include in the changelog
              May also be specified with the GIT_CLIFF_WITH_COMMIT environment
              variable.

       --skip-commit=SHA1
              Sets commits that will be skipped in the changelog
              May also be specified with the GIT_CLIFF_SKIP_COMMIT environment
              variable.

       -p, --prepend=PATH
              Prepends entries to the given changelog file
              May also be specified with the GIT_CLIFF_PREPEND environment
              variable.

       -o, --output=PATH
              Writes output to the given file
              May also be specified with the GIT_CLIFF_OUTPUT environment
              variable.

       -t, --tag=TAG
              Sets the tag for the latest version
              May also be specified with the GIT_CLIFF_TAG environment
              variable.

       --bump Bumps the version for unreleased changes

       --bumped-version
              Prints bumped version for unreleased changes

       -b, --body=TEMPLATE
              Sets the template for the changelog body
              May also be specified with the GIT_CLIFF_TEMPLATE environment
              variable.

       -l, --latest
              Processes the commits starting from the latest tag

       --current
              Processes the commits that belong to the current tag

       -u, --unreleased
              Processes the commits that do not belong to a tag

       --topo-order
              Sorts the tags topologically

       --no-exec
              Disables the external command execution

       -x, --context
              Prints changelog context as JSON

       -s, --strip=PART
              Strips the given parts from the changelog

              [possible values: header, footer, all]

       --sort=SORT [default: oldest]
              Sets sorting of the commits inside sections

              [possible values: oldest, newest]

       --github-token=TOKEN
              Sets the GitHub API token
              May also be specified with the GITHUB_TOKEN environment
              variable.

       --github-repo=OWNER/REPO
              Sets the GitHub repository
              May also be specified with the GITHUB_REPO environment variable.

       [RANGE]
              Sets the commit range to process

VERSION
       v2.2.2

AUTHORS
       git-cliff contributors <git-cliff@protonmail.com>

                                git-cliff 2.2.2                   git-cliff(1)