Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-CLI(1)		 lightning-cli		      LIGHTNING-CLI(1)

NAME
       lightning-cli - Control lightning daemon

SYNOPSIS
       lightning-cli [OPTIONS] commanda|

DESCRIPTION
       lightning-cli sends commands to the lightning daemon.

OPTIONS
	--lightning-dir=DIR  Set  the directory	for the	lightning daemon weare
       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  op-
       tional 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 isnat	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.

							      LIGHTNING-CLI(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | COMMANDS | ARGUMENTS | EXAMPLES | BUGS | AUTHOR | RESOURCES | COPYING

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=lightning-cli&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help