nushell/crates/nu_plugin_example
2024-09-18 00:48:46 -07:00
..
src Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
Cargo.toml Bump version to 0.98.0 (#13865) 2024-09-18 00:48:46 -07:00
README.md remove the deprecated register command (#13297) 2024-07-05 07:16:50 -05:00

Plugin Example

Crate with a simple example of the Plugin trait that needs to be implemented in order to create a binary that can be registered into nushell declaration list

example config

This subcommand demonstrates sending configuration from the nushell $env.config to a plugin.

To make use of the plugin after building nushell run:

plugin add target/debug/nu_plugin_example
# or then either restart your current nushell session or run:
plugin use target/debug/nu_plugin_example

The configuration for the plugin lives in $env.config.plugins.example:

$env.config = {
  plugins: {
    example: [
      some
      values
    ]
  }
}

To list plugin values run:

example config