mirror of
https://github.com/nushell/nushell.git
synced 2024-12-04 14:25:25 +01:00
b27cd70fd1
# Description This PR removes the `register` command which has been [deprecated](https://www.nushell.sh/blog/2024-04-30-nushell_0_93_0.html#register-toc) in favor of [`plugin add`](https://www.nushell.sh/blog/2024-04-30-nushell_0_93_0.html#redesigned-plugin-management-commands-toc) # User-Facing Changes `register` is no longer available
37 lines
742 B
Markdown
37 lines
742 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 make use of the plugin after building `nushell` run:
|
|
|
|
```nushell
|
|
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`:
|
|
|
|
```nushell
|
|
$env.config = {
|
|
plugins: {
|
|
example: [
|
|
some
|
|
values
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
To list plugin values run:
|
|
|
|
```nushell
|
|
example config
|
|
```
|
|
|