nushell/docs/commands/module.md
Justin Ma c0a1d18e3d
update #4455, regenerate commands' docs and update make_docs script (#4586)
* feat: update #4455, regenerate commands' docs

* chore: update make_docs script
2022-02-21 11:26:00 -06:00

697 B

title layout version
module command 0.59.0

Define a custom module

Signature

> module (module_name) (block)

Parameters

  • module_name: module name
  • block: body of the module

Examples

Define a custom command in a module and call it

> module spam { export def foo [] { "foo" } }; use spam foo; foo

Define an environment variable in a module and evaluate it

> module foo { export env FOO_ENV { "BAZ" } }; use foo FOO_ENV; $env.FOO_ENV

Define a custom command that participates in the environment in a module and call it

> module foo { export def-env bar [] { let-env FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR