Skip to content

Commit cd26bb2

Browse files
okydkorhun
andauthored
docs(quickstart): clarify git-cliff command (#1051)
* Update initializing.md * docs: add dash * docs: add dash to all commands * docs: Change example and add tip * Revert "Merge branch 'patch-1' of https://github.com/okydk/git-cliff into patch-1" This reverts commit a3402bd, reversing changes made to 701f395. * fix: typo * Update website/docs/index.md --------- Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
1 parent fab02b0 commit cd26bb2

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

website/docs/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,23 @@ Also, see the other [installation options](installation).
2121
2. Initialize **git-cliff**:
2222

2323
```bash
24-
git cliff --init
24+
git-cliff --init
2525
```
2626

2727
Edit the default [configuration](configuration) (`cliff.toml`) as you like. Check out the [examples](templating/examples) for different templates.
2828

2929
3. Generate a changelog:
3030

3131
```bash
32-
git cliff -o CHANGELOG.md
32+
git-cliff -o CHANGELOG.md
3333
```
3434

3535
See the [command-line usage examples](usage/examples).
3636

37+
:::note
38+
The `git cliff` command can also be used interchangeably with `git-cliff` (with a `-`) in most environments (when `git` is installed). However, when using the [NPM](/docs/installation/npm) installation method is used, the `git-cliff` command should be used.
39+
:::
40+
3741
## Contribute
3842

3943
Contributions are highly appreciated! See the [contribution guidelines](https://github.com/orhun/git-cliff/blob/main/CONTRIBUTING.md) for getting started.

0 commit comments

Comments
 (0)