help modules

For core.

Show help on nushell modules.

Command Type

built-in

Signature

> help modules {flags} ...rest

Flags

  • --find, -f {string}: String to find in module names and descriptions.

Parameters

  • ...rest: The name of module to get help on.

Input/output types:

input output
nothing table

Examples

Show all modules.

> help modules

Show help for single module.

> help modules my-module

Search for string in module names and descriptions.

> help modules --find my-module

Notes

When requesting help for a single module, its commands and aliases will be highlighted if they are also available in the current scope. Commands/aliases that were imported under a different name (such as with a prefix after use some-module) will be highlighted in parentheses.

Ported from nushell/nushell.github.io. Copyright (c) 2021 Nushell Project. MIT License.