Command Line Interface

Search…

litd can be accessed using the litcli, pool, loop and frcli command line interfaces (CLI).

Starting with version 0.6, litd comes with a command line interface litcli. This interface is primarily used to generate new sessions for Lightning Node Connect, e.g. to connect to the web-based Lightning Terminal at terminal.lightning.engineering.

In addition, litd optionally bundles the Pool, Loop and Faraday clients including their command line interfaces. To include these, install litd with the commands
make go-install-cli
make install
Alternatively, Pool, Loop and Faraday can be installed separately, and their CLIs can be used to call the bundled binaries in litd. It is important to specify the correct port, as litd will run poold, loopd and faraday on a separate port, making it possible to run two instances of loop or pool simultaneously. The TLS path also needs to be specified. Alternatively the tls.cert can be copied from .lit/tls.cert to .pool/mainnet, .loop/mainnet and .faraday/mainnet
To make use of these tools as seen in the examples below:
litcli
litcli --lndtlscertpath ~/.lit/tls.cert sessions add --label="My LNC" --type admin
By default, a pairing phrase created with litcli is valid for 3 months and is set to "readonly", meaning invoices cannot be paid or created and channels cannot be opened. You may extend this with the --expiry <seconds> and --type flags.
pool
pool --tlscertpath ~/.lit/tls.cert --rpcserver=localhost:8443 orders
​Read more about the pool CLI​
loop
loop --tlscertpath ~/.lit/tls.cert --rpcserver=localhost:8443 terms
​Read more about the loop CLI​
frcli
frcli --tlscertpath ~/.lit/tls.cert --rpcserver=localhost:8443 insights
​Read more about the Faraday CLI​

Pool and Lightning Terminal

Troubleshooting

Last modified 3mo ago

Copy link

Contents