docs: use git-cliff in copy-paste command examples

wyf027 · cursoragent · wyf027 · commit c13e245e5bab · 2026-05-25T11:08:28.000+08:00
Replace `git cliff` with `git-cliff` in documentation and CI examples so commands work in environments where git is not installed (e.g. Alpine with only the git-cliff package). Fixes #1387 Co-authored-by: Cursor <cursoragent@cursor.com>
diff --git a/.github/actions/run-fixtures-test/action.yml b/.github/actions/run-fixtures-test/action.yml
@@ -56,7 +56,7 @@ runs:
         if [ -n '${{ inputs.include-path-env }}' ]; then
           export GIT_CLIFF_INCLUDE_PATH='${{ inputs.include-path-env }}'
         fi
-        git cliff --config cliff.toml ${{ inputs.command }} > output.md
+        git-cliff --config cliff.toml ${{ inputs.command }} > output.md
         echo "$?" > output.rc
         if [ -f output.md ]; then
           cat output.md
diff --git a/website/docs/configuration/remote.md b/website/docs/configuration/remote.md
@@ -35,7 +35,7 @@ If you are using GitHub, you can use the `--github-repo` argument or `GITHUB_REP
 e.g.
 
 ```bash
-git cliff --github-repo orhun/git-cliff
+git-cliff --github-repo orhun/git-cliff
 ```
 
 Same applies for GitLab/Bitbucket with `--gitlab-repo`/`--gitea-repo`/`--bitbucket-repo` and `GITLAB_REPO`/`GITEA_REPO`/`BITBUCKET_REPO` environment variables.
@@ -47,7 +47,7 @@ Sets the access token for the remote.
 If you are using GitHub, then you can also pass this value via `--github-token` argument or `GITHUB_TOKEN` environment variable as follows:
 
 ```bash
-git cliff --github-token <TOKEN>
+git-cliff --github-token <TOKEN>
 ```
 
 Same applies for GitLab/Bitbucket with `--gitlab-token`/`--gitea-token`/`--bitbucket-token` and `GITLAB_TOKEN`/`GITEA_TOKEN`/`BITBUCKET_TOKEN` environment variables.
diff --git a/website/docs/github-actions/setup-git-cliff.md b/website/docs/github-actions/setup-git-cliff.md
@@ -14,7 +14,7 @@ While `git-cliff-action` uses the Docker image generated by [docker.yml](https:/
   uses: kenji-miyake/setup-git-cliff@v1
 
 - name: Run git-cliff
-  run: git cliff
+  run: git-cliff
 ```
 
 See a practical example [here](https://github.com/autowarefoundation/autoware-github-actions/blob/v1/generate-changelog/action.yaml).
diff --git a/website/docs/integration/azure-devops.md b/website/docs/integration/azure-devops.md
@@ -58,7 +58,7 @@ To set an access token, you can use the [configuration file](/docs/configuration
 For example:
 
 ```bash
-AZURE_DEVOPS_TOKEN="***" git cliff --azure-devops-repo "myorg/myproject/myrepo"
+AZURE_DEVOPS_TOKEN="***" git-cliff --azure-devops-repo "myorg/myproject/myrepo"
 ```
 
 :::tip
diff --git a/website/docs/integration/bitbucket.md b/website/docs/integration/bitbucket.md
@@ -50,7 +50,7 @@ To set an access token, you can use the [configuration file](/docs/configuration
 For example:
 
 ```bash
-BITBUCKET_TOKEN="***" git cliff --bitbucket-repo "orhun/git-cliff"
+BITBUCKET_TOKEN="***" git-cliff --bitbucket-repo "orhun/git-cliff"
 ```
 
 :::tip
diff --git a/website/docs/integration/gitea.md b/website/docs/integration/gitea.md
@@ -50,7 +50,7 @@ To set an access token, you can use the [configuration file](/docs/configuration
 For example:
 
 ```bash
-GITEA_TOKEN="***" git cliff --gitea-repo "orhun/git-cliff"
+GITEA_TOKEN="***" git-cliff --gitea-repo "orhun/git-cliff"
 ```
 
 :::tip
diff --git a/website/docs/integration/github.md b/website/docs/integration/github.md
@@ -54,7 +54,7 @@ To set the access token, you can use the [configuration file](/docs/configuratio
 For example:
 
 ```bash
-GITHUB_TOKEN="***" git cliff --github-repo "orhun/git-cliff"
+GITHUB_TOKEN="***" git-cliff --github-repo "orhun/git-cliff"
 ```
 
 :::tip
@@ -191,7 +191,7 @@ If you would like to create a changelog similar to the GitHub's default format,
 Since it is already embedded into the binary, you can simply run:
 
 ```bash
-git cliff -c github
+git-cliff -c github
 ```
 
 This will generate a changelog such as:
diff --git a/website/docs/integration/gitlab.md b/website/docs/integration/gitlab.md
@@ -50,7 +50,7 @@ To set an access token, you can use the [configuration file](/docs/configuration
 For example:
 
 ```bash
-GITLAB_TOKEN="***" git cliff --gitlab-repo "orhun/git-cliff"
+GITLAB_TOKEN="***" git-cliff --gitlab-repo "orhun/git-cliff"
 ```
 
 :::tip
diff --git a/website/docs/sourcehut.md b/website/docs/sourcehut.md
@@ -20,7 +20,7 @@ environment:
 tasks:
   - git-cliff: |
       cd $dir
-      git cliff -o CHANGELOG.md
+      git-cliff -o CHANGELOG.md
       ssh-keyscan -t rsa git.sr.ht >> ~/.ssh/known_hosts
       git remote set-url origin $source
       git checkout main
diff --git a/website/docs/usage/adding-commits.md b/website/docs/usage/adding-commits.md
@@ -7,7 +7,7 @@ sidebar_position: 9
 In some cases, you might want to include commit messages in the changelog that yet don't exist. One example would be having "the commit message that updates the changelog" in the changelog. (🤔)
 
 ```bash
-git cliff -o CHANGELOG.md
+git-cliff -o CHANGELOG.md
 git add CHANGELOG.md
 git commit -m "chore(release): update CHANGELOG.md for 1.0.0"
 ```
@@ -19,7 +19,7 @@ In the example above, `CHANGELOG.md` will not have the latest commit message sin
 commit_msg="chore(release): update CHANGELOG.md for 1.0.0"
 
 # generate changelog and pretend a commit exists as "$commit_msg"
-git cliff --with-commit "$commit_msg" -o CHANGELOG.md
+git-cliff --with-commit "$commit_msg" -o CHANGELOG.md
 
 # create the actual commit
 git add CHANGELOG.md
diff --git a/website/docs/usage/adding-tag-messages.md b/website/docs/usage/adding-tag-messages.md
@@ -30,7 +30,7 @@ So in the release's context, `message` will be "first release, yay!" (even if it
 If for some reason you don't want to have the message in the tag (or don't have a tag yet) but want to include it in the generated changelog, you can use the `--with-tag-message` flag:
 
 ```bash
-git cliff --bump --unreleased --with-tag-message "some text"
+git-cliff --bump --unreleased --with-tag-message "some text"
 ```
 
 In this case, you can only add a message to the latest release.
diff --git a/website/docs/usage/bump-version.md b/website/docs/usage/bump-version.md
@@ -7,7 +7,7 @@ sidebar_position: 4
 To calculate and set the next semantic version (i.e. _bump the version_) for the unreleased changes:
 
 ```bash
-git cliff --bump
+git-cliff --bump
 ```
 
 - Basic:
@@ -33,15 +33,15 @@ The next version is checked against the regex value set by [tag_pattern](/docs/c
 You can also calculate and print the next semantic version to `stdout`:
 
 ```bash
-git cliff --bumped-version
+git-cliff --bumped-version
 ```
 
 :::tip
 
 You can also get the bumped version [from the context](/docs/usage/print-context) as follows:
 
 ```bash
-git cliff --unreleased --bump --context | jq -r .[0].version
+git-cliff --unreleased --bump --context | jq -r .[0].version
 ```
 
 :::
@@ -51,7 +51,7 @@ git cliff --unreleased --bump --context | jq -r .[0].version
 Optionally, you can specify a bump type in `--bump`:
 
 ```bash
-git cliff --bump [major|minor|patch]
+git-cliff --bump [major|minor|patch]
 ```
 
 ## Zero-based versioning scheme
diff --git a/website/docs/usage/examples.md b/website/docs/usage/examples.md
@@ -9,74 +9,74 @@ To simply create a changelog at your projects git root directory:
 ```bash
 # same as running `git-cliff --config cliff.toml --repository .`
 # same as running `git-cliff --workdir .`
-git cliff
+git-cliff
 ```
 
 Set a tag for the unreleased changes:
 
 ```bash
 # generates a changelog for the tag '1.0.0' without creating the tag itself
-git cliff --tag 1.0.0
+git-cliff --tag 1.0.0
 ```
 
 Generate a changelog for a certain part of git history:
 
 ```bash
 # only takes the latest tag into account
-git cliff --latest
+git-cliff --latest
 
 # only takes the current tag into account
 # useful if you checkout a specific tag (e.g. `git checkout v0.0.1`)
 # (requires a tag to be present for the current commit (i.e. HEAD))
-git cliff --current
+git-cliff --current
 
 # generate changelog for unreleased commits
-git cliff --unreleased
-git cliff --unreleased --tag 1.0.0
+git-cliff --unreleased
+git-cliff --unreleased --tag 1.0.0
 ```
 
 Generate a changelog for a specific commit range (based on [git ranges](https://git-scm.com/docs/git-range-diff)):
 
 ```bash
-git cliff 4c7b043..a440c6e
-git cliff 4c7b043..HEAD
-git cliff HEAD~2..
-git cliff v2.2.1..
-git cliff v0.1.0..HEAD
+git-cliff 4c7b043..a440c6e
+git-cliff 4c7b043..HEAD
+git-cliff HEAD~2..
+git-cliff v2.2.1..
+git-cliff v0.1.0..HEAD
 ```
 
 Only include the tags from the current branch:
 
 ```bash
-git cliff --use-branch-tags
+git-cliff --use-branch-tags
 ```
 
 Sort the commits inside sections:
 
 ```bash
 # The oldest commit will be on top.
 # (default)
-git cliff --sort oldest
+git-cliff --sort oldest
 
 # The newest commit will be on top.
-git cliff --sort newest
+git-cliff --sort newest
 ```
 
 Sort the tags in topological order:
 
 ```bash
 # Process in topological order instead of chronological.
-git cliff --topo-order
+git-cliff --topo-order
 ```
 
 Save the changelog file to the specified file:
 
 ```bash
 # Set output path
-git cliff --output CHANGELOG.md
+git-cliff --output CHANGELOG.md
 
 # Without path, the default is `CHANGELOG.md`
-git cliff -o
+git-cliff -o
 ```
 
 Prepend new changes to an existing changelog file:
@@ -85,18 +85,18 @@ Prepend new changes to an existing changelog file:
 # 1- changelog header is removed from CHANGELOG.md
 # 2- new entries are prepended to CHANGELOG.md without footer part
 # the --prepend option is incompatible with -o (output) if the file paths are equal
-git cliff --unreleased --tag 1.0.0 --prepend CHANGELOG.md
+git-cliff --unreleased --tag 1.0.0 --prepend CHANGELOG.md
 ```
 
 Set/remove the changelog parts:
 
 ```bash
-git cliff --body $template --strip footer
+git-cliff --body $template --strip footer
 ```
 
 Skip running the commands defined in [pre](/docs/configuration/git#commit_preprocessors)/[postprocessors](/docs/configuration/changelog#postprocessors).
 
 ```bash
 # No external command execution
-git cliff --no-exec
+git-cliff --no-exec
 ```
diff --git a/website/docs/usage/initializing.md b/website/docs/usage/initializing.md
@@ -8,7 +8,7 @@ The default [configuration file](/docs/configuration) (`cliff.toml`) can be gene
 
 ```bash
 # create cliff.toml
-git cliff --init
+git-cliff --init
 
 # create a config file with a custom name
 git-cliff --init --config custom.toml
@@ -20,14 +20,14 @@ To initialize `git-cliff` with one of those templates, simply use the name of th
 
 ```bash
 # create cliff.toml with Keep a Changelog format
-git cliff --init keepachangelog
+git-cliff --init keepachangelog
 ```
 
 Also, you can use a template without creating the configuration file. Just give the name of the template to the `--config` option as follows:
 
 ```bash
 # generate a changelog with using the built-in "detailed" template
-git cliff --config detailed
+git-cliff --config detailed
 ```
 
 Here are the list of available templates:
@@ -47,7 +47,7 @@ Here are the list of available templates:
 It is also possible to use a remote URL for the configuration file as follows:
 
 ```bash
-git cliff --config-url https://github.com/orhun/git-cliff/blob/main/examples/github-keepachangelog.toml?raw=true
+git-cliff --config-url https://github.com/orhun/git-cliff/blob/main/examples/github-keepachangelog.toml?raw=true
 ```
 
 :::
diff --git a/website/docs/usage/load-context.md b/website/docs/usage/load-context.md
@@ -14,13 +14,13 @@ To load a context from a file and output the generated changelog:
 
 ```bash
 # create a context
-git cliff --context -o context.json
+git-cliff --context -o context.json
 
 # process context and generate a changelog
-git cliff --from-context context.json
+git-cliff --from-context context.json
 
 # process context loaded from stdin
-git cliff --from-context -
+git-cliff --from-context -
 ```
 
 Free-form metadata can be added to release objects and commit objects in the context using the `extra` field:
diff --git a/website/docs/usage/monorepos.md b/website/docs/usage/monorepos.md
@@ -8,14 +8,14 @@ You can generate a changelog scoped to a specific directory by just switching to
 
 ```bash
 cd packages/some_library
-git cliff
+git-cliff
 ```
 
 To include/exclude specific paths, use the `--include-path` and `--exclude-path` arguments:
 
 ```bash
 cd packages/some_library
-git cliff --include-path "packages/some_library/**/*" --exclude-path ".github/*"
+git-cliff --include-path "packages/some_library/**/*" --exclude-path ".github/*"
 ```
 
 These paths must be relative to the repository's root and should be a valid glob pattern.
diff --git a/website/docs/usage/multiple-repos.md b/website/docs/usage/multiple-repos.md
@@ -7,7 +7,7 @@ sidebar_position: 6
 To generate a changelog for multiple git repositories:
 
 ```bash
-git cliff --repository path1 path2
+git-cliff --repository path1 path2
 ```
 
 Note that the changelog will be generated using the merged history of the given repositories.
diff --git a/website/docs/usage/print-context.md b/website/docs/usage/print-context.md
@@ -8,8 +8,8 @@ To print the changelog [context](/docs/templating/context) as JSON:
 
 ```bash
 # print context to stdout
-git cliff --context
+git-cliff --context
 
 # save context to a file
-git cliff --context --output context.json
+git-cliff --context --output context.json
 ```
diff --git a/website/docs/usage/skipping-commits.md b/website/docs/usage/skipping-commits.md
@@ -7,7 +7,7 @@ sidebar_position: 8
 You can use `--skip-commit` argument to skip specific commits by their SHA1 value:
 
 ```bash
-git cliff --skip-commit a78bc368e9ee382a3016c0c4bab41f7de4503bcd
+git-cliff --skip-commit a78bc368e9ee382a3016c0c4bab41f7de4503bcd
 ```
 
 If you have multiple commits to skip, you can either use this argument multiple times or create `.cliffignore` at the root of your repository.
