Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 1.96 KB

help.md

File metadata and controls

69 lines (48 loc) · 1.96 KB
title categories version core usage feature
help
core
0.94.0
Display help information about different parts of Nushell.
Display help information about different parts of Nushell.
default

help for core

Display help information about different parts of Nushell.

Signature

> help {flags} ...rest

Flags

  • --find, -f {string}: string to find in command names, usage, and search terms

Parameters

  • ...rest: The name of command, alias or module to get help on.

Input/output types:

input output
nothing any

Examples

show help for single command, alias, or module

> help match

show help for single sub-command, alias, or module

> help str join

search for string in command names, usage and search terms

> help --find char

Notes

help word searches for "word" in commands, aliases and modules, in that order.

Subcommands:

name usage type
help aliases Show help on nushell aliases. built-in
help commands Show help on nushell commands. built-in
help escapes Show help on nushell string escapes. built-in
help externs Show help on nushell externs. built-in
help modules Show help on nushell modules. built-in
help operators Show help on nushell operators. built-in