Home

Awesome

cln-scripts

Various shell scripts for CLN (Core Lightning / c-lightning). I also have some scripts for Bitcoin Core.

Installation

Dependencies: bash, lightning-cli (comes with CLN), bc, jq.

Gentoo Linux users can use my portage overlay:

# eselect repository add kristapsk git https://github.com/kristapsk/portage-overlay.git
# emerge -av cln-scripts

Otherwise, use provided install.sh script, which will install everything in /opt/cln-scripts with symlinks in /usr/local/bin (so that they are on PATH).

Usage

All scripts support -h/--help for usage information.

ScriptDescription
cln-amboss-pingSend node health check ping to Amboss, see docs.
cln-channelbalanceReturns the sum of the total available channel balance across all open channels, like lncli channelbalance of LND.
cln-feereportDisplay the current fee policies of all active channels, like lncli feereport of LND.
cln-prune-protectorProtect CLN against Bitcoin Core pruning too much.
cln-routing-summaryDisplay routing summary for a given period.
cln-random-traffic-genGenerate random (decoy) LN traffic between you and your peers to fight traffic analysis. Has lock protection against running multiple instances at the same time so can safely be just added to crontab.
cln-walletbalanceCompute and display the onchain wallet's current balance, like lncli walletbalance of LND.

Support

If you want to support my work on this project and other free software (I am also maintainer of JoinMarket and do other Bitcoin stuff), you can send some sats (Bitcoin) either here (that's my self-hosted SatSale instance) or to my WoS LN address tritejogging43@walletofsatoshi.com (my old public CLN node is temporary down).