Skip to content

Commit 0ff1336

Browse files
tesujimathfdncred
andauthored
Add reference to Nu Plugin Tracer in the Nushell Book. (#1372)
* Add reference to Nu Plugin Tracer in the Nushell Book. * Rename nu_plugin_tracer as trace_nu_plugin * Add trace output accumulation warning inline Its also in the README for trace_nu_plugin * Refer to plugin rm to remove plugin Co-authored-by: Darren Schroeder <[email protected]> --------- Co-authored-by: Darren Schroeder <[email protected]>
1 parent dbcfd59 commit 0ff1336

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

book/plugins.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,12 @@ Nu's main repo contains example plugins that are useful for learning how the plu
170170

171171
The simplest way to debug a plugin is to print to stderr; plugins' standard error streams are redirected through Nu and displayed to the user.
172172

173+
### Tracing
174+
175+
The Nu plugin protocol message stream may be captured for diagnostic purposes using [trace_nu_plugin](https://crates.io/crates/trace_nu_plugin/).
176+
177+
**WARNING: trace output will accumulate for as long as the plugin is installed with the trace wrapper. Large files are possible. Be sure to remove the plugin with `plugin rm` when finished tracing, and reinstall without the trace wrapper.**
178+
173179
## Help
174180

175181
Nu's plugin documentation is a work in progress. If you're unsure about something, the #plugins channel on [the Nu Discord](https://discord.gg/NtAbbGn) is a great place to ask questions!

0 commit comments

Comments
 (0)