GlcoinCore/cln-plugins
1
0
Fork 0
mirror of https://github.com/lightningd/plugins.git synced 2026-08-18 13:09:00 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

README: touch on starting plugins via RPC, and two nits

Browse source 
Signed-off-by: Antoine Poinsot <darosior@protonmail.com>
This commit is contained in:
Antoine Poinsot 2020-12-11 12:33:44 +01:00 • committed by Christian Decker
parent 3be58b2580
commit 3923bc787f
1 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -55,9 +55,25 @@ Notes:
Alternatively, especially when you use multiple plugins, you can copy or symlink
all plugin directories into your `~/.lightning/plugins` directory. The daemon
will load each executeable it finds in sub-directories as a plugin. In this case
will load each executable it finds in sub-directories as a plugin. In this case
you don't need to manage all the `--plugin=...` parameters.
### Dynamic plugin initialization
Most of the plugins can be managed using the RPC interface. Use
```
lightning-cli plugin start /path/to/plugin/directory/plugin_file_name
```
to start it, and
```
lightning-cli plugin stop /path/to/plugin/directory/plugin_file_name
```
to stop it.
As a plugin developer this option is configurable with all the available plugin libraries,
and defaults to `true`.
### PYTHONPATH and `pyln`
To simplify plugin development you can rely on `pyln-client` for the plugin
@ -158,7 +174,7 @@ your environment.
[graphql-spec]: https://graphql.org/
[lightning-qt]: https://github.com/darosior/pylightning-qt
[cpp-api]: https://github.com/darosior/lightningcpp
[js-api]: https://github.com/darosior/clightningjs
[js-api]: https://github.com/lightningd/clightningjs
[monitor]: https://github.com/renepickhardt/plugins/tree/master/monitor
[reckless]: https://github.com/darosior/reckless
[request-invoice]: https://github.com/lightningd/plugins/tree/master/request-invoice