schemas: remove lightning- prefix from filename
This commit will fail in `make` due to unchanged scripts. They will be added in the next commit.
This commit is contained in:
parent
d7319795b4
commit
ad6a599d51
6
.gitignore
vendored
6
.gitignore
vendored
@ -57,9 +57,9 @@ tests/plugins/test_selfdisable_after_getmanifest
|
||||
|
||||
# Ignore generated files
|
||||
devtools/features
|
||||
doc/schemas/lightning-sql.json
|
||||
doc/lightning-*.7.md
|
||||
doc/lightning*.[1578]
|
||||
doc/schemas/sql.json
|
||||
doc/*.7.md
|
||||
doc/*.[1578]
|
||||
doc/reckless*.[1578]
|
||||
*_sqlgen.[ch]
|
||||
*_wiregen.[ch]
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
290
doc/index.rst
290
doc/index.rst
@ -12,153 +12,155 @@ Core Lightning Documentation
|
||||
:caption: Manpages
|
||||
|
||||
.. block_start manpages
|
||||
lightning-addgossip <lightning-addgossip.7.md>
|
||||
lightning-addpsbtoutput <lightning-addpsbtoutput.7.md>
|
||||
lightning-askrene-age <lightning-askrene-age.7.md>
|
||||
lightning-askrene-bias-channel <lightning-askrene-bias-channel.7.md>
|
||||
lightning-askrene-create-channel <lightning-askrene-create-channel.7.md>
|
||||
lightning-askrene-create-layer <lightning-askrene-create-layer.7.md>
|
||||
lightning-askrene-disable-node <lightning-askrene-disable-node.7.md>
|
||||
lightning-askrene-inform-channel <lightning-askrene-inform-channel.7.md>
|
||||
lightning-askrene-listlayers <lightning-askrene-listlayers.7.md>
|
||||
lightning-askrene-listreservations <lightning-askrene-listreservations.7.md>
|
||||
lightning-askrene-remove-layer <lightning-askrene-remove-layer.7.md>
|
||||
lightning-askrene-reserve <lightning-askrene-reserve.7.md>
|
||||
lightning-askrene-unreserve <lightning-askrene-unreserve.7.md>
|
||||
lightning-askrene-update-channel <lightning-askrene-update-channel.7.md>
|
||||
lightning-autoclean-once <lightning-autoclean-once.7.md>
|
||||
lightning-autoclean-status <lightning-autoclean-status.7.md>
|
||||
lightning-batching <lightning-batching.7.md>
|
||||
lightning-bkpr-channelsapy <lightning-bkpr-channelsapy.7.md>
|
||||
lightning-bkpr-dumpincomecsv <lightning-bkpr-dumpincomecsv.7.md>
|
||||
lightning-bkpr-editdescriptionbyoutpoint <lightning-bkpr-editdescriptionbyoutpoint.7.md>
|
||||
lightning-bkpr-editdescriptionbypaymentid <lightning-bkpr-editdescriptionbypaymentid.7.md>
|
||||
lightning-bkpr-inspect <lightning-bkpr-inspect.7.md>
|
||||
lightning-bkpr-listaccountevents <lightning-bkpr-listaccountevents.7.md>
|
||||
lightning-bkpr-listbalances <lightning-bkpr-listbalances.7.md>
|
||||
lightning-bkpr-listincome <lightning-bkpr-listincome.7.md>
|
||||
lightning-blacklistrune <lightning-blacklistrune.7.md>
|
||||
lightning-check <lightning-check.7.md>
|
||||
lightning-checkmessage <lightning-checkmessage.7.md>
|
||||
lightning-checkrune <lightning-checkrune.7.md>
|
||||
addgossip <addgossip.7.md>
|
||||
addpsbtoutput <addpsbtoutput.7.md>
|
||||
askrene-age <askrene-age.7.md>
|
||||
askrene-bias-channel <askrene-bias-channel.7.md>
|
||||
askrene-create-channel <askrene-create-channel.7.md>
|
||||
askrene-create-layer <askrene-create-layer.7.md>
|
||||
askrene-disable-node <askrene-disable-node.7.md>
|
||||
askrene-inform-channel <askrene-inform-channel.7.md>
|
||||
askrene-listlayers <askrene-listlayers.7.md>
|
||||
askrene-listreservations <askrene-listreservations.7.md>
|
||||
askrene-remove-layer <askrene-remove-layer.7.md>
|
||||
askrene-reserve <askrene-reserve.7.md>
|
||||
askrene-unreserve <askrene-unreserve.7.md>
|
||||
askrene-update-channel <askrene-update-channel.7.md>
|
||||
autoclean-once <autoclean-once.7.md>
|
||||
autoclean-status <autoclean-status.7.md>
|
||||
batching <batching.7.md>
|
||||
bkpr-channelsapy <bkpr-channelsapy.7.md>
|
||||
bkpr-dumpincomecsv <bkpr-dumpincomecsv.7.md>
|
||||
bkpr-editdescriptionbyoutpoint <bkpr-editdescriptionbyoutpoint.7.md>
|
||||
bkpr-editdescriptionbypaymentid <bkpr-editdescriptionbypaymentid.7.md>
|
||||
bkpr-inspect <bkpr-inspect.7.md>
|
||||
bkpr-listaccountevents <bkpr-listaccountevents.7.md>
|
||||
bkpr-listbalances <bkpr-listbalances.7.md>
|
||||
bkpr-listincome <bkpr-listincome.7.md>
|
||||
blacklistrune <blacklistrune.7.md>
|
||||
check <check.7.md>
|
||||
checkmessage <checkmessage.7.md>
|
||||
checkrune <checkrune.7.md>
|
||||
close <close.7.md>
|
||||
commando <commando.7.md>
|
||||
commando-blacklist <commando-blacklist.7.md>
|
||||
commando-listrunes <commando-listrunes.7.md>
|
||||
commando-rune <commando-rune.7.md>
|
||||
connect <connect.7.md>
|
||||
createinvoice <createinvoice.7.md>
|
||||
createonion <createonion.7.md>
|
||||
createrune <createrune.7.md>
|
||||
datastore <datastore.7.md>
|
||||
datastoreusage <datastoreusage.7.md>
|
||||
decode <decode.7.md>
|
||||
decodepay <decodepay.7.md>
|
||||
deldatastore <deldatastore.7.md>
|
||||
delforward <delforward.7.md>
|
||||
delinvoice <delinvoice.7.md>
|
||||
delpay <delpay.7.md>
|
||||
deprecations <deprecations.7.md>
|
||||
dev-forget-channel <dev-forget-channel.7.md>
|
||||
dev-splice <dev-splice.7.md>
|
||||
disableinvoicerequest <disableinvoicerequest.7.md>
|
||||
disableoffer <disableoffer.7.md>
|
||||
disconnect <disconnect.7.md>
|
||||
emergencyrecover <emergencyrecover.7.md>
|
||||
enableoffer <enableoffer.7.md>
|
||||
exposesecret <exposesecret.7.md>
|
||||
feerates <feerates.7.md>
|
||||
fetchinvoice <fetchinvoice.7.md>
|
||||
fundchannel <fundchannel.7.md>
|
||||
fundchannel_cancel <fundchannel_cancel.7.md>
|
||||
fundchannel_complete <fundchannel_complete.7.md>
|
||||
fundchannel_start <fundchannel_start.7.md>
|
||||
funderupdate <funderupdate.7.md>
|
||||
fundpsbt <fundpsbt.7.md>
|
||||
getemergencyrecoverdata <getemergencyrecoverdata.7.md>
|
||||
getinfo <getinfo.7.md>
|
||||
getlog <getlog.7.md>
|
||||
getroute <getroute.7.md>
|
||||
getroutes <getroutes.7.md>
|
||||
help <help.7.md>
|
||||
injectonionmessage <injectonionmessage.7.md>
|
||||
injectpaymentonion <injectpaymentonion.7.md>
|
||||
invoice <invoice.7.md>
|
||||
invoicerequest <invoicerequest.7.md>
|
||||
keysend <keysend.7.md>
|
||||
lightning-cli <lightning-cli.1.md>
|
||||
lightning-close <lightning-close.7.md>
|
||||
lightning-commando <lightning-commando.7.md>
|
||||
lightning-connect <lightning-connect.7.md>
|
||||
lightning-createinvoice <lightning-createinvoice.7.md>
|
||||
lightning-createonion <lightning-createonion.7.md>
|
||||
lightning-createrune <lightning-createrune.7.md>
|
||||
lightning-datastore <lightning-datastore.7.md>
|
||||
lightning-datastoreusage <lightning-datastoreusage.7.md>
|
||||
lightning-decode <lightning-decode.7.md>
|
||||
lightning-decodepay <lightning-decodepay.7.md>
|
||||
lightning-deldatastore <lightning-deldatastore.7.md>
|
||||
lightning-delforward <lightning-delforward.7.md>
|
||||
lightning-delinvoice <lightning-delinvoice.7.md>
|
||||
lightning-delpay <lightning-delpay.7.md>
|
||||
lightning-deprecations <lightning-deprecations.7.md>
|
||||
lightning-dev-forget-channel <lightning-dev-forget-channel.7.md>
|
||||
lightning-dev-splice <lightning-dev-splice.7.md>
|
||||
lightning-disableinvoicerequest <lightning-disableinvoicerequest.7.md>
|
||||
lightning-disableoffer <lightning-disableoffer.7.md>
|
||||
lightning-disconnect <lightning-disconnect.7.md>
|
||||
lightning-emergencyrecover <lightning-emergencyrecover.7.md>
|
||||
lightning-enableoffer <lightning-enableoffer.7.md>
|
||||
lightning-exposesecret <lightning-exposesecret.7.md>
|
||||
lightning-feerates <lightning-feerates.7.md>
|
||||
lightning-fetchinvoice <lightning-fetchinvoice.7.md>
|
||||
lightning-fundchannel <lightning-fundchannel.7.md>
|
||||
lightning-fundchannel_cancel <lightning-fundchannel_cancel.7.md>
|
||||
lightning-fundchannel_complete <lightning-fundchannel_complete.7.md>
|
||||
lightning-fundchannel_start <lightning-fundchannel_start.7.md>
|
||||
lightning-funderupdate <lightning-funderupdate.7.md>
|
||||
lightning-fundpsbt <lightning-fundpsbt.7.md>
|
||||
lightning-getemergencyrecoverdata <lightning-getemergencyrecoverdata.7.md>
|
||||
lightning-getinfo <lightning-getinfo.7.md>
|
||||
lightning-getlog <lightning-getlog.7.md>
|
||||
lightning-getroute <lightning-getroute.7.md>
|
||||
lightning-getroutes <lightning-getroutes.7.md>
|
||||
lightning-help <lightning-help.7.md>
|
||||
lightning-hsmtool <lightning-hsmtool.8.md>
|
||||
lightning-injectonionmessage <lightning-injectonionmessage.7.md>
|
||||
lightning-injectpaymentonion <lightning-injectpaymentonion.7.md>
|
||||
lightning-invoice <lightning-invoice.7.md>
|
||||
lightning-invoicerequest <lightning-invoicerequest.7.md>
|
||||
lightning-keysend <lightning-keysend.7.md>
|
||||
lightning-listaddresses <lightning-listaddresses.7.md>
|
||||
lightning-listchannels <lightning-listchannels.7.md>
|
||||
lightning-listclosedchannels <lightning-listclosedchannels.7.md>
|
||||
lightning-listconfigs <lightning-listconfigs.7.md>
|
||||
lightning-listdatastore <lightning-listdatastore.7.md>
|
||||
lightning-listforwards <lightning-listforwards.7.md>
|
||||
lightning-listfunds <lightning-listfunds.7.md>
|
||||
lightning-listhtlcs <lightning-listhtlcs.7.md>
|
||||
lightning-listinvoicerequests <lightning-listinvoicerequests.7.md>
|
||||
lightning-listinvoices <lightning-listinvoices.7.md>
|
||||
lightning-listnodes <lightning-listnodes.7.md>
|
||||
lightning-listoffers <lightning-listoffers.7.md>
|
||||
lightning-listpays <lightning-listpays.7.md>
|
||||
lightning-listpeerchannels <lightning-listpeerchannels.7.md>
|
||||
lightning-listpeers <lightning-listpeers.7.md>
|
||||
lightning-listsendpays <lightning-listsendpays.7.md>
|
||||
lightning-listsqlschemas <lightning-listsqlschemas.7.md>
|
||||
lightning-listtransactions <lightning-listtransactions.7.md>
|
||||
lightning-makesecret <lightning-makesecret.7.md>
|
||||
lightning-multifundchannel <lightning-multifundchannel.7.md>
|
||||
lightning-multiwithdraw <lightning-multiwithdraw.7.md>
|
||||
lightning-newaddr <lightning-newaddr.7.md>
|
||||
lightning-notifications <lightning-notifications.7.md>
|
||||
lightning-offer <lightning-offer.7.md>
|
||||
lightning-openchannel_abort <lightning-openchannel_abort.7.md>
|
||||
lightning-openchannel_bump <lightning-openchannel_bump.7.md>
|
||||
lightning-openchannel_init <lightning-openchannel_init.7.md>
|
||||
lightning-openchannel_signed <lightning-openchannel_signed.7.md>
|
||||
lightning-openchannel_update <lightning-openchannel_update.7.md>
|
||||
lightning-parsefeerate <lightning-parsefeerate.7.md>
|
||||
lightning-pay <lightning-pay.7.md>
|
||||
lightning-ping <lightning-ping.7.md>
|
||||
lightning-plugin <lightning-plugin.7.md>
|
||||
lightning-preapproveinvoice <lightning-preapproveinvoice.7.md>
|
||||
lightning-preapprovekeysend <lightning-preapprovekeysend.7.md>
|
||||
lightning-reckless <lightning-reckless.7.md>
|
||||
lightning-recover <lightning-recover.7.md>
|
||||
lightning-recoverchannel <lightning-recoverchannel.7.md>
|
||||
lightning-renepay <lightning-renepay.7.md>
|
||||
lightning-renepaystatus <lightning-renepaystatus.7.md>
|
||||
lightning-reserveinputs <lightning-reserveinputs.7.md>
|
||||
lightning-sendcustommsg <lightning-sendcustommsg.7.md>
|
||||
lightning-sendinvoice <lightning-sendinvoice.7.md>
|
||||
lightning-sendonion <lightning-sendonion.7.md>
|
||||
lightning-sendpay <lightning-sendpay.7.md>
|
||||
lightning-sendpsbt <lightning-sendpsbt.7.md>
|
||||
lightning-setchannel <lightning-setchannel.7.md>
|
||||
lightning-setconfig <lightning-setconfig.7.md>
|
||||
lightning-setpsbtversion <lightning-setpsbtversion.7.md>
|
||||
lightning-showrunes <lightning-showrunes.7.md>
|
||||
lightning-signinvoice <lightning-signinvoice.7.md>
|
||||
lightning-signmessage <lightning-signmessage.7.md>
|
||||
lightning-signpsbt <lightning-signpsbt.7.md>
|
||||
lightning-splice_init <lightning-splice_init.7.md>
|
||||
lightning-splice_signed <lightning-splice_signed.7.md>
|
||||
lightning-splice_update <lightning-splice_update.7.md>
|
||||
lightning-sql <lightning-sql.7.md>
|
||||
lightning-staticbackup <lightning-staticbackup.7.md>
|
||||
lightning-stop <lightning-stop.7.md>
|
||||
lightning-txdiscard <lightning-txdiscard.7.md>
|
||||
lightning-txprepare <lightning-txprepare.7.md>
|
||||
lightning-txsend <lightning-txsend.7.md>
|
||||
lightning-unreserveinputs <lightning-unreserveinputs.7.md>
|
||||
lightning-upgradewallet <lightning-upgradewallet.7.md>
|
||||
lightning-utxopsbt <lightning-utxopsbt.7.md>
|
||||
lightning-wait <lightning-wait.7.md>
|
||||
lightning-waitanyinvoice <lightning-waitanyinvoice.7.md>
|
||||
lightning-waitblockheight <lightning-waitblockheight.7.md>
|
||||
lightning-waitinvoice <lightning-waitinvoice.7.md>
|
||||
lightning-waitsendpay <lightning-waitsendpay.7.md>
|
||||
lightning-withdraw <lightning-withdraw.7.md>
|
||||
lightning-xpay <lightning-xpay.7.md>
|
||||
lightningd <lightningd.8.md>
|
||||
lightningd-config <lightningd-config.5.md>
|
||||
lightningd-rpc <lightningd-rpc.7.md>
|
||||
lightningd <lightningd.8.md>
|
||||
listaddresses <listaddresses.7.md>
|
||||
listchannels <listchannels.7.md>
|
||||
listclosedchannels <listclosedchannels.7.md>
|
||||
listconfigs <listconfigs.7.md>
|
||||
listdatastore <listdatastore.7.md>
|
||||
listforwards <listforwards.7.md>
|
||||
listfunds <listfunds.7.md>
|
||||
listhtlcs <listhtlcs.7.md>
|
||||
listinvoicerequests <listinvoicerequests.7.md>
|
||||
listinvoices <listinvoices.7.md>
|
||||
listnodes <listnodes.7.md>
|
||||
listoffers <listoffers.7.md>
|
||||
listpays <listpays.7.md>
|
||||
listpeerchannels <listpeerchannels.7.md>
|
||||
listpeers <listpeers.7.md>
|
||||
listsendpays <listsendpays.7.md>
|
||||
listsqlschemas <listsqlschemas.7.md>
|
||||
listtransactions <listtransactions.7.md>
|
||||
makesecret <makesecret.7.md>
|
||||
multifundchannel <multifundchannel.7.md>
|
||||
multiwithdraw <multiwithdraw.7.md>
|
||||
newaddr <newaddr.7.md>
|
||||
notifications <notifications.7.md>
|
||||
offer <offer.7.md>
|
||||
openchannel_abort <openchannel_abort.7.md>
|
||||
openchannel_bump <openchannel_bump.7.md>
|
||||
openchannel_init <openchannel_init.7.md>
|
||||
openchannel_signed <openchannel_signed.7.md>
|
||||
openchannel_update <openchannel_update.7.md>
|
||||
parsefeerate <parsefeerate.7.md>
|
||||
pay <pay.7.md>
|
||||
ping <ping.7.md>
|
||||
plugin <plugin.7.md>
|
||||
preapproveinvoice <preapproveinvoice.7.md>
|
||||
preapprovekeysend <preapprovekeysend.7.md>
|
||||
reckless <reckless.7.md>
|
||||
recover <recover.7.md>
|
||||
recoverchannel <recoverchannel.7.md>
|
||||
renepay <renepay.7.md>
|
||||
renepaystatus <renepaystatus.7.md>
|
||||
reserveinputs <reserveinputs.7.md>
|
||||
sendcustommsg <sendcustommsg.7.md>
|
||||
sendinvoice <sendinvoice.7.md>
|
||||
sendonion <sendonion.7.md>
|
||||
sendpay <sendpay.7.md>
|
||||
sendpsbt <sendpsbt.7.md>
|
||||
setchannel <setchannel.7.md>
|
||||
setconfig <setconfig.7.md>
|
||||
setpsbtversion <setpsbtversion.7.md>
|
||||
showrunes <showrunes.7.md>
|
||||
signinvoice <signinvoice.7.md>
|
||||
signmessage <signmessage.7.md>
|
||||
signpsbt <signpsbt.7.md>
|
||||
splice_init <splice_init.7.md>
|
||||
splice_signed <splice_signed.7.md>
|
||||
splice_update <splice_update.7.md>
|
||||
sql <sql.7.md>
|
||||
staticbackup <staticbackup.7.md>
|
||||
stop <stop.7.md>
|
||||
txdiscard <txdiscard.7.md>
|
||||
txprepare <txprepare.7.md>
|
||||
txsend <txsend.7.md>
|
||||
unreserveinputs <unreserveinputs.7.md>
|
||||
upgradewallet <upgradewallet.7.md>
|
||||
utxopsbt <utxopsbt.7.md>
|
||||
wait <wait.7.md>
|
||||
waitanyinvoice <waitanyinvoice.7.md>
|
||||
waitblockheight <waitblockheight.7.md>
|
||||
waitinvoice <waitinvoice.7.md>
|
||||
waitsendpay <waitsendpay.7.md>
|
||||
withdraw <withdraw.7.md>
|
||||
xpay <xpay.7.md>
|
||||
.. block_end manpages
|
||||
|
||||
@ -1,150 +1,207 @@
|
||||
reckless - install and activate a CLN plugin by name
|
||||
====================================================
|
||||
reckless -- Issue a command to the reckless plugin manager utility
|
||||
==================================================================
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
**reckless** [*options*] **install/uninstall/enable/disable/source** *target*
|
||||
**reckless** *command* [*target/subcommand*] [*target*]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
Reckless is a plugin manager for Core-Lightning. Typical plugin
|
||||
installation involves: finding the source plugin, copying,
|
||||
installing dependencies, testing, activating, and updating the
|
||||
lightningd config file. Reckless does all of these by invoking:
|
||||
The **reckless** RPC starts a reckless process with the *command* and *target* provided. Node configuration, network, and lightning direrctory are automatically passed to the reckless utility.
|
||||
|
||||
**reckless** **install**[@*commit/tag*] *plugin\_name*
|
||||
|
||||
reckless will exit early in the event that:
|
||||
|
||||
- the plugin is not found in any available source repositories
|
||||
- dependencies are not successfully installed
|
||||
- the plugin fails to execute
|
||||
|
||||
Reckless-installed plugins reside in the 'reckless' subdirectory
|
||||
of the user's `.lightning` folder. By default, plugins are activated
|
||||
on the `bitcoin` network (and use lightningd's bitcoin network
|
||||
config), but regtest may also be used.
|
||||
|
||||
Other commands include:
|
||||
|
||||
**reckless** **uninstall** *plugin\_name*
|
||||
disables the plugin, removes the directory.
|
||||
|
||||
**reckless** **search** *plugin\_name*
|
||||
looks through all available sources for a plugin matching
|
||||
this name.
|
||||
|
||||
**reckless** **enable** *plugin\_name*
|
||||
dynamically enables the reckless-installed plugin and updates
|
||||
the config to match.
|
||||
|
||||
**reckless** **disable** *plugin\_name*
|
||||
dynamically disables the reckless-installed plugin and updates
|
||||
the config to match.
|
||||
|
||||
**reckless** **source** **list**
|
||||
list available plugin repositories.
|
||||
|
||||
**reckless** **source** **add** *repo\_url*
|
||||
add another plugin repo for reckless to search.
|
||||
|
||||
**reckless** **source** **rm** *repo\_url*
|
||||
remove a plugin repo for reckless to search.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
Available option flags:
|
||||
|
||||
**-d**, **--reckless-dir** *reckless\_dir*
|
||||
specify an alternative data directory for reckless to use.
|
||||
Useful if your .lightning is protected from execution.
|
||||
|
||||
**-l**, **--lightning** *lightning\_data\_dir*
|
||||
lightning data directory (defaults to $USER/.lightning)
|
||||
|
||||
**-c**, **--conf** *lightning\_config*
|
||||
pass the config used by lightningd
|
||||
|
||||
**-r**, **--regtest**
|
||||
use the regtest network and config instead of bitcoin mainnet
|
||||
|
||||
**-v**, **--verbose**
|
||||
request additional debug output
|
||||
|
||||
**--network**=*network*
|
||||
specify bitcoin, regtest, liquid, liquid-regtest, litecoin, signet,
|
||||
or testnet networks. (default: bitcoin)
|
||||
- **command** (string) (one of "install", "uninstall", "search", "enable", "disable", "source", "--version"): Determines which command to pass to reckless
|
||||
- *command* **install** takes a *plugin\_name* to search for and install a named plugin.
|
||||
- *command* **uninstall** takes a *plugin\_name* and attempts to uninstall a plugin of the same name.
|
||||
- *command* **search** takes a *plugin\_name* to search for a named plugin.
|
||||
...
|
||||
- **target/subcommand** (one of, optional): Target of a reckless command or a subcommand.:
|
||||
- (string)
|
||||
- (array)
|
||||
- **target** (one of, optional): *name* of a plugin to install/uninstall/search/enable/disable or source to add/remove.:
|
||||
- (string)
|
||||
- (array)
|
||||
|
||||
NOTES
|
||||
-----
|
||||
|
||||
Reckless currently supports python and javascript plugins.
|
||||
Running the first time will prompt the user that their lightningd's bitcoin config will be appended (or created) to inherit the reckless config file (this config is specific to bitcoin by default.). Management of plugins will subsequently modify this file.
|
||||
|
||||
Running the first time will prompt the user that their lightningd's
|
||||
bitcoin config will be appended (or created) to inherit the reckless
|
||||
config file (this config is specific to bitcoin by default.)
|
||||
Management of plugins will subsequently modify this file.
|
||||
Available option flags:
|
||||
**-d**, **--reckless-dir** *reckless\_dir*: specify an alternative data directory for reckless to use. Useful if your .lightning is protected from execution.
|
||||
|
||||
**-l**, **--lightning** *lightning\_data\_dir*: lightning data directory (defaults to $USER/.lightning)
|
||||
|
||||
**-c**, **--conf** *lightning\_config*: pass the config used by lightningd
|
||||
|
||||
**-r**, **--regtest**: use the regtest network and config instead of bitcoin mainnet
|
||||
|
||||
**-v**, **--verbose**: request additional debug output
|
||||
|
||||
**--network**=*network*: specify bitcoin, regtest, liquid, liquid-regtest, litecoin, signet, or testnet networks. (default: bitcoin)
|
||||
|
||||
**--version**: print the version of reckless and exit
|
||||
|
||||
|
||||
Troubleshooting tips:
|
||||
|
||||
Plugins must be executable. For python plugins, the shebang is
|
||||
invoked, so **python3** should be available in your environment. This
|
||||
can be verified with **which Python3**. The default reckless directory
|
||||
is $USER/.lightning/reckless and it should be possible for the
|
||||
lightningd user to execute files located here. If this is a problem,
|
||||
the option flag **reckless -d=<my\_alternate\_dir>** may be used to
|
||||
relocate the reckless directory from its default. Consider creating a
|
||||
permanent alias in this case.
|
||||
|
||||
Python plugins are installed to their own virtual environments. The
|
||||
environment is activated by a wrapper (named the same as the plugin)
|
||||
which then imports and executes the actual plugin entrypoint.
|
||||
Plugins must be executable. For python plugins, the shebang is invoked, so **python3** should be available in your environment. This can be verified with **which Python3**. The default reckless directory is $USER/.lightning/reckless and it should be possible for the lightningd user to execute files located here. If this is a problem, the option flag **reckless -d=<my\_alternate\_dir>** may be used to relocate the reckless directory from its default. Consider creating a permanent alias in this case.
|
||||
Python plugins are installed to their own virtual environments. The environment is activated by a wrapper (named the same as the plugin) which then imports and executes the actual plugin entrypoint.
|
||||
|
||||
For Plugin Developers:
|
||||
|
||||
To make your plugin compatible with reckless install:
|
||||
- Choose a unique plugin name: The plugin entrypoint is inferred. Naming your plugin executable the same as your plugin name will allow reckless to identify it correctly (file extensions are okay.)
|
||||
- For python plugins, a requirements.txt is the preferred medium for python dependencies. A pyproject.toml will be used as a fallback, but test installation via `pip install -e .` - Poetry looks for additional files in the working directory, whereas with pip, any references to these will require something like `packages = [{ include = "*.py" }]` under the `[tool.poetry]` section.
|
||||
- Additional repository sources may be added with `reckless source add https://my.repo.url/here` however, https://github.com/lightningd/plugins is included by default. Consider adding your plugin lightningd/plugins to make installation simpler.
|
||||
- If your plugin is located in a subdirectory of your repo with a different name than your plugin, it will likely be overlooked.
|
||||
|
||||
- Choose a unique plugin name.
|
||||
- The plugin entrypoint is inferred. Naming your plugin executable
|
||||
the same as your plugin name will allow reckless to identify it
|
||||
correctly (file extensions are okay.)
|
||||
- For python plugins, a requirements.txt is the preferred medium for
|
||||
python dependencies. A pyproject.toml will be used as a fallback,
|
||||
but test installation via `pip install -e .` - Poetry looks for
|
||||
additional files in the working directory, whereas with pip, any
|
||||
references to these will require something like
|
||||
`packages = [{ include = "*.py" }]` under the `[tool.poetry]`
|
||||
section.
|
||||
- Additional repository sources may be added with
|
||||
`reckless source add https://my.repo.url/here` however,
|
||||
https://github.com/lightningd/plugins is included by default.
|
||||
Consider adding your plugin lightningd/plugins to make
|
||||
installation simpler.
|
||||
- If your plugin is located in a subdirectory of your repo with a
|
||||
different name than your plugin, it will likely be overlooked.
|
||||
RETURN VALUE
|
||||
------------
|
||||
|
||||
On success, an object is returned, containing:
|
||||
|
||||
- **result** (array of strings): Output of the requested reckless command.:
|
||||
- (string, optional)
|
||||
- **log** (array of strings): Verbose log entries of the requested reckless command.:
|
||||
- (string, optional)
|
||||
|
||||
AUTHOR
|
||||
------
|
||||
|
||||
Antoine Poinsot wrote the original reckless plugin on which this is
|
||||
based.
|
||||
Antoine Poinsot wrote the original reckless plugin on which this is based.
|
||||
|
||||
Rusty Russell wrote the outline for the reckless utility's function
|
||||
|
||||
Alex Myers <<alex@endothermic.dev>> is mostly responsible for the
|
||||
reckless code and this man page, with thanks to Christian Decker for
|
||||
extensive review.
|
||||
Alex Myers <<alex@endothermic.dev>> is mainly responsible for the reckless code and this man page, with thanks to Christian Decker for extensive review.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
Core-Lightning plugins repo: <https://github.com/lightningd/plugins>
|
||||
reckless(7)
|
||||
|
||||
RESOURCES
|
||||
---------
|
||||
|
||||
Core-Lightning plugins repo: <https://github.com/lightningd/plugins>
|
||||
Main web site: <https://github.com/ElementsProject/lightning>
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
|
||||
**Example 1**:
|
||||
|
||||
Request:
|
||||
```shell
|
||||
lightning-cli reckless -k "command"="search" "target/subcommand"="backup"
|
||||
```
|
||||
```json
|
||||
{
|
||||
"id": "example:reckless#1",
|
||||
"method": "reckless",
|
||||
"params": {
|
||||
"command": "search",
|
||||
"target/subcommand": "backup"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Response:
|
||||
```json
|
||||
{
|
||||
"result": [
|
||||
"https://github.com/lightningd/plugins"
|
||||
],
|
||||
"log": [
|
||||
"DEBUG: Warning: Reckless requires write access",
|
||||
"DEBUG: fetching from gh API: https://api.github.com/repos/lightningd/plugins/contents/",
|
||||
"DEBUG: fetching from gh API: https://api.github.com/repos/lightningd/plugins/git/trees/294f93d7060799439c994daa84f534c4d1458325",
|
||||
"INFO: found backup in source: https://github.com/lightningd/plugins",
|
||||
"DEBUG: entry: None",
|
||||
"DEBUG: sub-directory: backup"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Example 2**:
|
||||
|
||||
Request:
|
||||
```shell
|
||||
lightning-cli reckless -k "command"="install" "target/subcommand"='["summars", "currecyrate"]'
|
||||
```
|
||||
```json
|
||||
{
|
||||
"id": "example:reckless#2",
|
||||
"method": "reckless",
|
||||
"params": {
|
||||
"command": "install",
|
||||
"target/subcommand": [
|
||||
"summars",
|
||||
"currecyrate"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Response:
|
||||
```json
|
||||
{
|
||||
"result": [
|
||||
"/tmp/l1/reckless/summars",
|
||||
"/tmp/l1/reckless/currencyrate"
|
||||
],
|
||||
"log": [
|
||||
"DEBUG: Searching for summars",
|
||||
"DEBUG: fetching from gh API: https://api.github.com/repos/lightningd/plugins/contents/",
|
||||
"DEBUG: fetching from gh API: https://api.github.com/repos/lightningd/plugins/git/trees/294f93d7060799439c994daa84f534c4d1458325",
|
||||
"INFO: found summars in source: https://github.com/lightningd/plugins",
|
||||
"DEBUG: entry: None",
|
||||
"DEBUG: sub-directory: summars",
|
||||
"DEBUG: Retrieving summars from https://github.com/lightningd/plugins",
|
||||
"DEBUG: Install requested from InstInfo(summars, https://github.com/lightningd/plugins, None, None, None, summars).",
|
||||
"INFO: cloning Source.GITHUB_REPO InstInfo(summars, https://github.com/lightningd/plugins, None, None, None, summars)",
|
||||
"DEBUG: cloned_src: InstInfo(summars, /tmp/reckless-726255950dyifh_fh/clone, None, Cargo.toml, Cargo.toml, summars/summars)",
|
||||
"DEBUG: using latest commit of default branch",
|
||||
"DEBUG: checked out HEAD: 5e449468bd57db7d0f33178fe0dc867e0da94133",
|
||||
"DEBUG: using installer rust",
|
||||
"DEBUG: creating /tmp/l1/reckless/summars",
|
||||
"DEBUG: creating /tmp/l1/reckless/summars/source",
|
||||
"DEBUG: copying /tmp/reckless-726255950dyifh_fh/clone/summars/summars tree to /tmp/l1/reckless/summars/source/summars",
|
||||
"DEBUG: linking source /tmp/l1/reckless/summars/source/summars/Cargo.toml to /tmp/l1/reckless/summars/Cargo.toml",
|
||||
"DEBUG: InstInfo(summars, /tmp/l1/reckless/summars, None, Cargo.toml, Cargo.toml, source/summars)",
|
||||
"DEBUG: cargo installing from /tmp/l1/reckless/summars/source/summars",
|
||||
"DEBUG: rust project compiled successfully",
|
||||
"INFO: plugin installed: /tmp/l1/reckless/summars",
|
||||
"DEBUG: activating summars",
|
||||
"INFO: summars enabled",
|
||||
"DEBUG: Searching for currencyrate",
|
||||
"DEBUG: fetching from gh API: https://api.github.com/repos/lightningd/plugins/contents/",
|
||||
"DEBUG: fetching from gh API: https://api.github.com/repos/lightningd/plugins/git/trees/294f93d7060799439c994daa84f534c4d1458325",
|
||||
"INFO: found currencyrate in source: https://github.com/lightningd/plugins",
|
||||
"DEBUG: entry: None",
|
||||
"DEBUG: sub-directory: currencyrate",
|
||||
"DEBUG: Retrieving currencyrate from https://github.com/lightningd/plugins",
|
||||
"DEBUG: Install requested from InstInfo(currencyrate, https://github.com/lightningd/plugins, None, None, None, currencyrate).",
|
||||
"INFO: cloning Source.GITHUB_REPO InstInfo(currencyrate, https://github.com/lightningd/plugins, None, None, None, currencyrate)",
|
||||
"DEBUG: cloned_src: InstInfo(currencyrate, /tmp/reckless-192564272t478naxn/clone, None, currencyrate.py, requirements.txt, currencyrate/currencyrate)",
|
||||
"DEBUG: using latest commit of default branch",
|
||||
"DEBUG: checked out HEAD: 5e449468bd57db7d0f33178fe0dc867e0da94133",
|
||||
"DEBUG: using installer python3venv",
|
||||
"DEBUG: creating /tmp/l1/reckless/currencyrate",
|
||||
"DEBUG: creating /tmp/l1/reckless/currencyrate/source",
|
||||
"DEBUG: copying /tmp/reckless-192564272t478naxn/clone/currencyrate/currencyrate tree to /tmp/l1/reckless/currencyrate/source/currencyrate",
|
||||
"DEBUG: linking source /tmp/l1/reckless/currencyrate/source/currencyrate/currencyrate.py to /tmp/l1/reckless/currencyrate/currencyrate.py",
|
||||
"DEBUG: InstInfo(currencyrate, /tmp/l1/reckless/currencyrate, None, currencyrate.py, requirements.txt, source/currencyrate)",
|
||||
"DEBUG: configuring a python virtual environment (pip) in /tmp/l1/reckless/currencyrate/.venv",
|
||||
"DEBUG: virtual environment created in /tmp/l1/reckless/currencyrate/.venv.",
|
||||
"INFO: dependencies installed successfully",
|
||||
"DEBUG: virtual environment for cloned plugin: .venv",
|
||||
"INFO: plugin installed: /tmp/l1/reckless/currencyrate",
|
||||
"DEBUG: activating currencyrate",
|
||||
"INFO: currencyrate enabled"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user