mirror of
https://github.com/aljazceru/lightning.git
synced 2026-02-16 03:24:23 +01:00
8b1aa3ef8b
lightning-cli is going to need to know what network we're on, so it will need to parse the config files. Move the code which does the initial bootstrap parsing into common, as well as the config file parsing core. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
102 lines
2.3 KiB
Markdown
102 lines
2.3 KiB
Markdown
lightning-cli -- Control lightning daemon
|
||
=========================================
|
||
|
||
SYNOPSIS
|
||
--------
|
||
|
||
**lightning-cli** \[*OPTIONS*\] *command*…
|
||
|
||
DESCRIPTION
|
||
-----------
|
||
|
||
**lightning-cli** sends commands to the lightning daemon.
|
||
|
||
OPTIONS
|
||
-------
|
||
|
||
**--lightning-dir**=*DIR*
|
||
Set the directory for the lightning daemon we’re talking to; defaults to
|
||
*$HOME/.lightning*.
|
||
|
||
**--conf**=*PATH*
|
||
Sets configuration file (default: **lightning-dir**/*config* ).
|
||
|
||
**--network**=*network*
|
||
**--mainnet**
|
||
**--testnet**
|
||
**--signet**
|
||
Sets network explicitly.
|
||
|
||
**--rpc-file**=*FILE*
|
||
Named pipe to use to talk to lightning daemon: default is
|
||
*lightning-rpc* in the lightning directory.
|
||
|
||
**--keywords**/**-k**
|
||
Use format *key*=*value* for parameters in any order
|
||
|
||
**--order**/**-o**
|
||
Follow strictly the order of parameters for the command
|
||
|
||
**--json**/**-J**
|
||
Return result in JSON format (default unless *help* command)
|
||
|
||
**--raw**/**-R**
|
||
Return raw JSON directly as lightningd replies
|
||
|
||
**--human-readable**/**-H**
|
||
Return result in human-readable output (default for *help* command)
|
||
|
||
**--help**/**-h**
|
||
Print summary of options to standard output and exit.
|
||
|
||
**--version**/**-V**
|
||
Print version number to standard output and exit.
|
||
|
||
COMMANDS
|
||
--------
|
||
|
||
*lightning-cli* simply uses the JSON RPC interface to talk to
|
||
*lightningd*, and prints the results. Thus the commands available depend
|
||
entirely on the lightning daemon itself.
|
||
|
||
ARGUMENTS
|
||
---------
|
||
|
||
Arguments may be provided positionally or using *key*=*value* after the
|
||
command name, based on either **-o** or **-k** option. Arguments may be
|
||
integer numbers (composed entirely of digits), floating-point numbers
|
||
(has a radix point but otherwise composed of digits), *true*, *false*,
|
||
or *null*. Other arguments are treated as strings.
|
||
|
||
Some commands have optional arguments. You may use *null* to skip
|
||
optional arguments to provide later arguments.
|
||
|
||
EXAMPLES
|
||
--------
|
||
|
||
Example 1. List commands
|
||
|
||
lightning-cli help
|
||
|
||
BUGS
|
||
----
|
||
|
||
This manpage documents how it should work, not how it does work. The
|
||
pretty printing of results isn’t pretty.
|
||
|
||
AUTHOR
|
||
------
|
||
|
||
Rusty Russell <<rusty@rustcorp.com.au>> is mainly to blame.
|
||
|
||
RESOURCES
|
||
---------
|
||
|
||
Main web site: <https://github.com/ElementsProject/lightning>
|
||
|
||
COPYING
|
||
-------
|
||
|
||
Note: the modules in the ccan/ directory have their own licenses, but
|
||
the rest of the code is covered by the BSD-style MIT license.
|