Skip to content

Commit 962b936

Browse files
committed
plugin cache file ⇒ plugin registry file
1 parent bb6392d commit 962b936

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

book/plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Keep in mind that when installing using crates.io, the binary can be saved in di
3838

3939
## Adding a plugin
4040

41-
To add a plugin to the plugin cache file, call the [`plugin add`](/commands/docs/plugin_add.md) command to tell Nu where to find it.
41+
To add a plugin to the plugin registry file, call the [`plugin add`](/commands/docs/plugin_add.md) command to tell Nu where to find it.
4242

4343
Please note that the plugin name needs to start with `nu_plugin_`, Nu uses the name prefix to detect plugins.
4444

@@ -54,7 +54,7 @@ Windows:
5454
> plugin add .\my_plugins\nu_plugin_cool.exe
5555
```
5656

57-
When [`plugin add`](/commands/docs/plugin_add.md) is called, Nu runs the plugin binary and communicates via the [plugin protocol](plugin_protocol_reference.md) to get the signatures of all of the commands the plugin supports. It then saves information about the plugin, including the command signatures, to the plugin cache file at `$nu.plugin-path` in a custom brotli-compressed MessagePack format. This caching step saves `nu` from having to run all plugins during startup, which could be very slow.
57+
When [`plugin add`](/commands/docs/plugin_add.md) is called, Nu runs the plugin binary and communicates via the [plugin protocol](plugin_protocol_reference.md) to get the signatures of all of the commands the plugin supports. It then saves information about the plugin, including the command signatures, to the plugin registry file at `$nu.plugin-path` in a custom brotli-compressed MessagePack format. This caching step saves `nu` from having to run all plugins during startup, which could be very slow.
5858

5959
Once added, the next time `nu` is started, the plugin's commands are available as part of your set of commands:
6060

contributor-book/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For more detailed information about how exactly this communication works, especi
1616

1717
## Discovery
1818

19-
Nu keeps a registry of plugins known as the ‘plugin cache file’ at the file system location defined by configuration variable `$nu.plugin-path`. To add a plugin, execute `plugin add <path_to_plugin_executable>` in a Nu shell. The plugin's signatures will be added to the plugin cache file for future launches of Nu. To make them available immediately, call `plugin use <plugin_name>`.
19+
Nu keeps a registry of plugins known as the ‘plugin registry file’ at the file system location defined by configuration variable `$nu.plugin-path`. To add a plugin, execute `plugin add <path_to_plugin_executable>` in a Nu shell. The plugin's signatures will be added to the plugin registry file for future launches of Nu. To make them available immediately, call `plugin use <plugin_name>`.
2020

2121
## Launch environment
2222

0 commit comments

Comments
 (0)