'\" t .\" Title: lightning-cli .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 09/06/2016 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" .TH "LIGHTNING\-CLI" "1" "09/06/2016" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" lightning-cli \- Control lightning daemon .SH "SYNOPSIS" .sp \fBlightning\-cli\fR [\fIOPTIONS\fR] \fIcommand\fR\&... .SH "DESCRIPTION" .sp \fBlightning\-cli\fR sends commands to the lightning daemon\&. .SH "OPTIONS" .PP \fB\-\-lightning\-dir\fR=\fIDIR\fR .RS 4 Set the directory for the lightning daemon we\(cqre talking to; defaults to \fI$HOME/\&.lightning\fR\&. .RE .PP \fB\-\-rpc\-file\fR=\fIFILE\fR .RS 4 Named pipe to use to to talk to lightning daemon: default is \fIlightning\-rpc\fR in the lightning directory\&. .RE .PP \fB\-\-help\fR/\fB\-h\fR .RS 4 Print summary of options to standard output and exit\&. .RE .PP \fB\-\-version\fR/\fB\-V\fR .RS 4 Print version number to standard output and exit\&. .RE .SH "COMMANDS" .sp \fIlightning\-cli\fR simply uses the JSON RPC interface to talk to \fIlightningd\fR, and prints the results\&. Thus the commands available depend entirely on the lightning daemon itself\&. .SH "EXAMPLES" .PP \fBExample\ \&1.\ \&List commands\fR .sp lighting\-cli help .SH "BUGS" .sp This manpage documents how it should work, not how it does work\&. The pretty printing of results isn\(cqt pretty\&. .SH "AUTHOR" .sp Rusty Russell is mainly to blame\&. .SH "RESOURCES" .sp Main web site: https://github\&.com/ElementsProject/lightning .SH "COPYING" .sp 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\&.