Skip to content

Commit

Permalink
Update help.md with correct --help usage (#162)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoannmoinet authored May 29, 2024
1 parent aa8c9b3 commit 6ab54a3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions website/docs/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ A second example
$ my-app my-command --with-parameter
```

## The `help` command
## The `--help` flag

The builtin `help` command prints the list of available commands. To add it, simply import and register it:
The builtin `--help` flag prints the list of available commands. To add it, simply import and register it:

```ts
import {Cli, Builtins} from "clipanion";
Expand All @@ -93,7 +93,7 @@ cli.register(Builtins.HelpCommand);
```

```
$ my-app help
$ my-app --help
```

```
Expand Down

0 comments on commit 6ab54a3

Please sign in to comment.