extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-04-12 15:28:18 +02:00
Code Issues Packages Projects Releases Wiki Activity
0d82d7df60
nushell/docs/commands/register.md
Justin Ma 0d82d7df60
Update documents for commands (#4796) 
* Update documents of commands

* Change plugin names for register command examples

* Remove unused docs [ci skip]
2022-03-09 08:05:35 -05:00

813 B
Raw Blame History

title layout version
register command 0.59.1

Register a plugin

Signature

> register (plugin) (signature) --encoding --shell

Parameters

  • plugin: path of executable for plugin
  • signature: Block with signature description as json object
  • --encoding {string}: Encoding used to communicate with plugin. Options: [capnp, json]
  • --shell {path}: path of shell used to run plugin (cmd, sh, python, etc)

Examples

Register nu_plugin_query plugin from ~/.cargo/bin/ dir

> register -e capnp ~/.cargo/bin/nu_plugin_query

Register nu_plugin_query plugin from nu -c(plugin will be available in that nu session only)

> let plugin = ((which nu).path.0 | path dirname | path join 'nu_plugin_query'); nu -c $'register -e capnp ($plugin); version'