/usr/bin/nu_plugin_example

Nushell Plugin
Encoder: msgpack
Version: 0.117.0
Plugin file path: /usr/bin/nu_plugin_example

Command: example
Description:
 > Example commands for Nushell plugins

Extra description:
 > The `example` plugin demonstrates usage of the Nushell plugin API.

Several commands provided to test and demonstrate different capabilities of
plugins exposed through the API. None of these commands are intended to be
particularly useful.

Flags:
  -h, --help: Display the help message for this command

Parameters:
======================

Command: example one
Description:
 > Plugin test example 1. Returns Value::Nothing

Extra description:
 > Extra description for example one

Flags:
  -h, --help: Display the help message for this command
  -f, --flag: A flag for the signature.
  -n, --named <string>: Named string.

Parameters:
  a <int>: Required integer value.
  b <string>: Required string value.
  (optional) opt <int>: Optional number.
  ...rest <string>: Rest value string.
======================

Command: example two
Description:
 > Plugin test example 2. Returns list of records

Flags:
  -h, --help: Display the help message for this command
  -f, --flag: A flag for the signature.
  -n, --named <string>: Named string.

Parameters:
  a <int>: Required integer value.
  b <string>: Required string value.
  (optional) opt <int>: Optional number.
  ...rest <string>: Rest value string.
======================

Command: example three
Description:
 > Plugin test example 3. Returns labeled error

Flags:
  -h, --help: Display the help message for this command
  -f, --flag: A flag for the signature.
  -n, --named <string>: Named string.

Parameters:
  a <int>: Required integer value.
  b <string>: Required string value.
  (optional) opt <int>: Optional number.
  ...rest <string>: Rest value string.
======================

Command: example config
Description:
 > Show plugin configuration

Extra description:
 > The configuration is set under $env.config.plugins.example

Flags:
  -h, --help: Display the help message for this command

Parameters:
======================

Command: example env
Description:
 > Get environment variable(s)

Extra description:
 > Returns all environment variables if no name provided

Flags:
  -h, --help: Display the help message for this command
  --cwd: Get current working directory instead.
  --set <any>: Set an environment variable to the value.

Parameters:
  (optional) name <string>: The name of the environment variable to get.
======================

Command: example view span
Description:
 > Example command for looking up the contents of a parser span

Extra description:
 > Shows the original source code of the expression that generated the value passed as input.

Flags:
  -h, --help: Display the help message for this command

Parameters:
======================

Command: example disable-gc
Description:
 > Disable the plugin garbage collector for `example`

Extra description:
 > Plugins are garbage collected by default after a period of inactivity. This
behavior is configurable with `$env.config.plugin_gc.default`, or to change it
specifically for the example plugin, use
`$env.config.plugin_gc.plugins.example`.

This command demonstrates how plugins can control this behavior and disable GC
temporarily if they need to. It is still possible to stop the plugin explicitly
using `plugin stop example`.

Flags:
  -h, --help: Display the help message for this command
  --reset: Turn the garbage collector back on.

Parameters:
======================

Command: example ctrlc
Description:
 > Example command that demonstrates registering an interrupt signal handler

Flags:
  -h, --help: Display the help message for this command

Parameters:
======================

Command: example call-decl
Description:
 > Demonstrates calling other commands from plugins using `call_decl()`.

Extra description:
 > The arguments will not be typechecked at parse time. This command is for
demonstration only, and should not be used for anything real.

Flags:
  -h, --help: Display the help message for this command

Parameters:
  name <string>: The name of the command to call.
  (optional) named_args <record>: Named arguments to pass to the command.
  ...positional_args <any>: Positional arguments to pass to the command.
======================

Command: example collect-bytes
Description:
 > Example transformer to byte stream

Flags:
  -h, --help: Display the help message for this command

Parameters:
======================

Command: example echo
Description:
 > Example stream consumer that outputs the received input

Flags:
  -h, --help: Display the help message for this command

Parameters:
======================

Command: example for-each
Description:
 > Example execution of a closure with a stream

Extra description:
 > Prints each value the closure returns to stderr

Flags:
  -h, --help: Display the help message for this command

Parameters:
  closure <closure(any)>: The closure to run for each input value.
======================

Command: example generate
Description:
 > Example execution of a closure to produce a stream

Extra description:
 > See the builtin `generate` command

Flags:
  -h, --help: Display the help message for this command

Parameters:
  initial <any>: The initial value to pass to the closure.
  closure <closure(any)>: The closure to run to generate values.
======================

Command: example seq
Description:
 > Example stream generator for a list of values

Flags:
  -h, --help: Display the help message for this command

Parameters:
  first <int>: First number to generate.
  last <int>: Last number to generate.
======================

Command: example sum
Description:
 > Example stream consumer for a list of values

Flags:
  -h, --help: Display the help message for this command

Parameters:
======================

Command: example arg-completion
Description:
 > It's a demo for arg completion, you can try to type `example arg-completion -f <tab>`to see what it returns

Flags:
  -h, --help: Display the help message for this command
  -f, --future-timestamp <int>: Example flag which support auto completion.

Parameters:
  first <string>: Required integer value.
  (optional) second <string>: optional second
======================