Skip to content

Documentation: some commands are missing '-' in git-cliff #1387

@KennyLorin

Description

@KennyLorin

Is there an existing issue for this?

  • I have searched the existing issues

Description of the bug

Having a look at this page of documentation, the following line is missing the '-' between git and cliff:

git cliff --init

In both this file and others, there is a mix of git-cliff and git cliff.

For cases where git is not available in the environment, this leads to unknown commands when copy/pasting.

It does not look like git-cliff needs git to work, i.e. when I run git-cliff -u it does read the contents of the commits successfully.

Steps To Reproduce

The following dockerfile was used:

FROM alpine:3.23.3

RUN apk add git-cliff

Then running:

/app $ git cliff 

returns

sh: git: not found

Expected behavior

Either:

  • indicate that git is required for git-cliff to work ("getting started" or "installation" page)
  • or ensure all example commands contain the '-'

Screenshots / Logs

No response

Software information

  • Operating system: 6.18.9-arch1-2, Docker version 29.2.1
  • Rust version: not installed
  • Project version: 2.2.2-r0

Additional context

No response

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions