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

FreeBSD Manual Pages

  
 
  

home | help
LITECOIN-CLI(1) 		  User Commands 		 LITECOIN-CLI(1)

NAME
     litecoin-cli - manual page for litecoin-cli v0.21.4.0

SYNOPSIS
     litecoin-cli [options] <command> [params]	Send command to Litecoin Core
     litecoin-cli  [options]  -named  <command> [name=value]...  Send command to
     Litecoin Core (with named arguments)
     litecoin-cli [options] help		List commands
     litecoin-cli [options] help <command>	Get help for a command

DESCRIPTION
     Litecoin Core RPC client version v0.21.4.0-dirty

OPTIONS
     -?

	    Print this help message and exit

     -conf=<file>

	    Specify configuration file.  Relative  paths  will	be  prefixed  by
	    datadir location. (default: litecoin.conf)

     -datadir=<dir>

	    Specify data directory

     -generate

	    Generate  blocks  immediately,  equivalent to RPC generatenewaddress
	    followed by RPC generatetoaddress. Optional positional integer argu-
	    ments are number of blocks to generate (default: 1) and maximum  it-
	    erations  to try (default: 1000000), equivalent to RPC generatetoad-
	    dress nblocks and maxtries arguments. Example: litecoin-cli  -gener-
	    ate 4 1000

     -getinfo

	    Get  general  information  from  the remote server. Note that unlike
	    server-side RPC calls, the results of -getinfo is the result of mul-
	    tiple non-atomic requests. Some entries in the result may  represent
	    results  from  different  states (e.g. wallet balance may be as of a
	    different block from the chain state reported)

     -named

	    Pass named instead of positional arguments (default: false)

     -netinfo

	    Get network peer connection information from the remote  server.  An
	    optional  integer  argument  from 0 to 4 can be passed for different
	    peers listings (default: 0).

     -rpcclienttimeout=<n>

	    Timeout in seconds during HTTP requests, or 0 for no  timeout.  (de-
	    fault: 900)

     -rpcconnect=<ip>

	    Send commands to node running on <ip> (default: 127.0.0.1)

     -rpccookiefile=<loc>

	    Location  of  the  auth cookie. Relative paths will be prefixed by a
	    net-specific datadir location. (default: data dir)

     -rpcpassword=<pw>

	    Password for JSON-RPC connections

     -rpcport=<port>

	    Connect to	JSON-RPC  on  <port>  (default:  9332,	testnet:  19332,
	    signet: 39332, regtest: 19443)

     -rpcuser=<user>

	    Username for JSON-RPC connections

     -rpcwait

	    Wait for RPC server to start

     -rpcwallet=<walletname>

	    Send  RPC  for  non-default  wallet  on RPC server (needs to exactly
	    match  corresponding  -wallet  option  passed  to  litecoind).  This
	    changes  the  RPC  endpoint  used,	e.g.  http://127.0.0.1:8332/wal-
	    let/<walletname>

     -stdin

	    Read extra	arguments  from  standard  input,  one	per  line  until
	    EOF/Ctrl-D	 (recommended	for   sensitive   information	such  as
	    passphrases). When combined with -stdinrpcpass, the first line  from
	    standard input is used for the RPC password.

     -stdinrpcpass

	    Read  RPC  password  from standard input as a single line. When com-
	    bined with -stdin, the first line from standard input  is  used  for
	    the RPC password. When combined with -stdinwalletpassphrase, -stdin-
	    rpcpass consumes the first line, and -stdinwalletpassphrase consumes
	    the second.

     -stdinwalletpassphrase

	    Read  wallet  passphrase  from standard input as a single line. When
	    combined with -stdin, the first line from standard input is used for
	    the wallet passphrase.

     -version

	    Print version and exit

     Debugging/Testing options:

     Chain selection options:

     -chain=<chain>

	    Use the chain <chain> (default: main). Allowed values:  main,  test,
	    signet, regtest

     -signet

	    Use  the  signet  chain.  Equivalent to -chain=signet. Note that the
	    network is defined by the -signetchallenge parameter

     -signetchallenge

	    Blocks must satisfy the given script to be	considered  valid  (only
	    for signet networks; defaults to the global default signet test net-
	    work challenge)

     -signetseednode

	    Specify  a	seed node for the signet network, in the hostname[:port]
	    format, e.g. sig.net:1234 (may be used  multiple  times  to  specify
	    multiple seed nodes; defaults to the global default signet test net-
	    work seed node(s))

     -testnet

	    Use the test chain. Equivalent to -chain=test.

COPYRIGHT
     Copyright	 (C)  2011-2024  The  Litecoin	Core  developers  Copyright  (C)
     2009-2024 The Bitcoin Core developers

     Please contribute if you find Litecoin Core  useful.  Visit  <https://lite-
     coin.org/>  for further information about the software.  The source code is
     available from <https://github.com/litecoin-project/litecoin>.

     This is experimental software.  Distributed under the MIT software license,
     see the accompanying file COPYING or <https://opensource.org/licenses/MIT>

litecoin-cli v0.21.4.0		  October 2024			 LITECOIN-CLI(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=litecoin-cli&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help