nushell/crates/nu_plugin_example
2024-06-05 06:52:40 +08:00
..
src Add string/binary type color to ByteStream (#12897) 2024-05-20 00:35:32 +00:00
Cargo.toml bump version to 0.94.3 (#13055) 2024-06-05 06:52:40 +08:00
README.md Merge stream_example into example plugin and clean up names (#12234) 2024-03-19 12:36:46 -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 register from after building nushell run:

register 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