W3cubDocs

/Nushell

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 string

Examples

show help for single command, alias, or module

>helpmatch

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

>helpstrlpad

search for string in command names, usage and search terms

>help--findchar

Notes

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

Subcommands:

name type usage
help aliases Builtin Show help on nushell aliases.
help commands Builtin Show help on nushell commands.
help externs Builtin Show help on nushell externs.
help modules Builtin Show help on nushell modules.
help operators Builtin Show help on nushell operators.

Copyright © 2019–2023 The Nushell Project DevelopersLicensed under the MIT License.
https://www.nushell.sh/commands/docs/help.html