Skip to content

Commit

Permalink
docs: improve CLI help command usage tips in user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
CryptoTotalWar committed Jul 25, 2024
1 parent c6c2f89 commit afe7dbe
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions docs/getting-started/installing-polykey-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -521,11 +521,21 @@ polykey --help

![pk-help.png](/images/pk-help.png)

:::tip
:::tip Use the CLI Helper Effectively

- To list all sub-commands available for a primary command, type:

```pkcli
polykey [primary command] --help
```

- For detailed information on a specific sub-command, type:

- Use polykey `[insert a primary command] --help` to list all sub-commands for a primary command.
```pkcli
polykey [primary command] [sub-command] --help
```

- Use polykey `[insert a primary command] [insert a sub-command] --help` for detailed information on specific sub-commands.
These commands provide you with helpful guidance on using different functionalities within Polykey.

:::

Expand Down

0 comments on commit afe7dbe

Please sign in to comment.