mirror of
https://github.com/nushell/nushell
synced 2024-12-29 06:23:11 +00:00
a29efe28f7
# Description As suggested by @WindSoilder, since plugins can now contain both simple commands that produce `Value` and commands that produce `PipelineData` without having to choose one or the other for the whole plugin, this change merges `stream_example` into `example`. # User-Facing Changes All of the example plugins are renamed. # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting - [ ] Check nushell/nushell.github.io for any docs that match the command names changed
34 lines
627 B
Markdown
34 lines
627 B
Markdown
# 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:
|
|
|
|
```nushell
|
|
register target/debug/nu_plugin_example
|
|
```
|
|
|
|
The configuration for the plugin lives in `$env.config.plugins.example`:
|
|
|
|
```nushell
|
|
$env.config = {
|
|
plugins: {
|
|
example: [
|
|
some
|
|
values
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
To list plugin values run:
|
|
|
|
```nushell
|
|
example config
|
|
```
|
|
|