overlay use for core

Signature

> overlay use {flags} (name) (as)

Flags

• --prefix, -p: Prepend module name to the imported commands and aliases
• --reload, -r: If the overlay already exists, reload its definitions and environment.

Parameters

• name: Module name to use overlay for
• as: as keyword followed by a new name

Input/output types:

Examples

Create an overlay from a module

>modulespam { export deffoo [] { "foo" } }
overlay usespam
foo

Create an overlay from a module and rename it

>modulespam { export deffoo [] { "foo" } }
overlay usespamasspam_new
foo

Create an overlay with a prefix

>'export def foo { "foo" }'
overlay use--prefixspam
spamfoo

Create an overlay from a file

>'export-env { $env.FOO = "foo" }'|savespam.nu
overlay usespam.nu
$env.FOO

Notes

This command is a parser keyword. For details, check: https://www.nushell.sh/book/thinking_in_nu.html