File tree Expand file tree Collapse file tree 1 file changed +21
-0
lines changed
Expand file tree Collapse file tree 1 file changed +21
-0
lines changed Original file line number Diff line number Diff line change @@ -21,3 +21,24 @@ Each folder usually includes:
2121
2222Every plugin is also listed in the [ CI workflow] ( ./.github/workflows/ci.yml ) to
2323ensure it gets tested regularly.
24+
25+ ## Write your own plugin
26+
27+ This repo contains examples of how to implement specific behaviors in Nushell
28+ plugins.
29+ If you want to stream data, return a table, handle arguments, or work with
30+ custom types, there's likely an example here that shows how to do it.
31+
32+ To build your own plugin from scratch:
33+
34+ - Start with our official plugin template for a clean setup:
35+ 👉 [ nushell/nu_plugin_template] ( https://github.com/nushell/nu_plugin_template )
36+
37+ - Read the full plugin guide in the Nushell book:
38+ 📚 [ Plugin guide on nushell.sh] ( https://www.nushell.sh/contributor-book/plugins.html )
39+
40+ You might need to update the Nushell dependencies in the plugin template,
41+ since it can lag behind the latest
42+ [ nushell] ( https://github.com/nushell/nushell ) version.
43+ For more real-world plugins, check out
44+ [ nushell/awesome-nu] ( https://github.com/nushell/awesome-nu?tab=readme-ov-file#plugins ) .
You can’t perform that action at this time.
0 commit comments