nushell/docs/commands/help.md

44 lines
581 B
Markdown
Raw Normal View History

---
title: help
layout: command
version: 0.59.0
---
2019-10-01 17:20:58 +02:00
Display help information about commands.
2019-10-01 17:20:58 +02:00
## Signature
```> help ...rest --find```
## Parameters
- `...rest`: the name of command to get help on
- `--find {string}`: string to find in command usage
## Examples
2019-10-01 17:20:58 +02:00
show all commands and sub-commands
2019-10-01 17:20:58 +02:00
```shell
> help commands
```
generate documentation
2019-10-01 17:20:58 +02:00
```shell
> help generate_docs
```
show help for single command
```shell
> help match
```
show help for single sub-command
```shell
> help str lpad
```
search for string in command usage
```shell
> help --find char
```