Skip to content

help_modules.md

Latest commit

 

History

History
60 lines (42 loc) · 1.2 KB

help_modules.md

File metadata and controls

60 lines (42 loc) · 1.2 KB
Raw
title help modules
categories core
version 0.112.0
core Show help on nushell modules.
usage Show help on nushell modules.
editLink false
contributors false

help modules for core

Show help on nushell modules.

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.