lightning-plugin.7

.TH "LIGHTNING-PLUGIN" "7" "" "" "lightning-plugin"
.SH NAME
lightning-plugin - Manage plugins with RPC
.SH SYNOPSIS

\fBplugin\fR command [parameter] [second_parameter]

.SH DESCRIPTION

The \fBplugin\fR RPC command allows to manage plugins without having to
restart lightningd\. It takes 1 to 3 parameters: a command
(start/stop/startdir/rescan/list) which describes the action to take and
optionally one or two parameters which describes the plugin on which the
action has to be taken\.


The \fIstart\fR command takes a path as parameter and will load the plugin
available from this path\.


The \fIstop\fR command takes a plugin name as parameter and will kill and
unload the specified plugin\.


The \fIstartdir\fR command takes a directory path as parameter and will load
all plugins this directory contains\.


The \fIrescan\fR command starts all not-already-loaded plugins from the
default plugins directory (by default \fI~/\.lightning/plugins\fR)\.


The \fIlist\fR command will return all the active plugins\.

.SH RETURN VALUE

On success, this returns an array \fIplugins\fR of objects, one by plugin\.
Each object contains the name of the plugin (\fIname\fR field) and its
status (\fIactive\fR boolean field)\. Since plugins are configured
asynchronously, a freshly started plugin may not appear immediately\.

.SH AUTHOR

Antoine Poinsot \fI<darosior@protonmail.com\fR> is mainly responsible\.

.SH RESOURCES

Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

.HL

Last updated 2019-07-29 12:57:57 CEST