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

FreeBSD Manual Pages

  
 
  

home | help 
LIGHTNING-HELP(7)					     LIGHTNING-HELP(7)

NAME
       lightning-help -- Command to return all information about RPC commands.

SYNOPSIS
       help [command]

DESCRIPTION
       The  help  is  a	 RPC command which is possible consult all information
       about the RPC commands, or a specific command if	command	is given.

       Note that the $ lightning-cli(1)	tool will prefer to list  a  man  page
       when  a specific	command	is specified, and will only return the JSON if
       the man page is not found.

       •  command (string, optional): Command to get information about.

RETURN VALUE
       On success, an object is	returned, containing:

       •  help (array of objects):

	  •  command (string): The command.
       •  format-hint (string, optional) (always "simple"): Prints the help in
	  human-readable flat form.

ERRORS
       On failure, one of the following	error codes may	be returned:

       •  -32602: Error	in given parameters.

AUTHOR
       Vincenzo	Palazzo	<<vincenzo.palazzo@protonmail.com>> wrote the  initial
       version of this man page, but many others did the hard work of actually
       implementing this rpc command.

RESOURCES
       Main web	site: <https://github.com/ElementsProject/lightning>

EXAMPLES
       Example 1:

       Request:

       $ lightning-cli help -k "command"="pay"

       {
	 "id": "example:help#1",
	 "method": "help",
	 "params": {
	   "command": "pay"
	 }
       }

       Response:

       {
	 "help": [
	   {
	     "command":	"pay bolt11 [amount_msat] [label] [riskfactor] [maxfeepercent] [retry_for] [maxdelay] [exemptfee] [localinvreqid] [exclude] [maxfee] [description] [partial_msat] [dev_use_shadow]"
	   }
	 ],
	 "format-hint":	"simple"
       }

       Example 2:

       Request:

       $ lightning-cli help -k "command"="dev"

       {
	 "id": "example:help#2",
	 "method": "help",
	 "params": {
	   "command": "dev"
	 }
       }

       Response:

       {
	 "help": [
	   {
	     "command":	"dev subcommand=crash|rhash|slowcmd"
	   }
	 ],
	 "format-hint":	"simple"
       }

Core Lightning v25.02					     LIGHTNING-HELP(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lightning-help&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>

home | help