limenka-cli.1 raw

   1  .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
   2  .TH LIMENKA-CLI "1" "May 2026" "limenka-cli v29.3.0.knots20260508" "User Commands"
   3  .SH NAME
   4  limenka-cli \- manual page for limenka-cli v29.3.0.knots20260508
   5  .SH SYNOPSIS
   6  .B limenka-cli
   7  [\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR]
   8  .br
   9  .B limenka-cli
  10  [\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]...
  11  .br
  12  .B limenka-cli
  13  [\fI\,options\/\fR] \fI\,help\/\fR
  14  .br
  15  .B limenka-cli
  16  [\fI\,options\/\fR] \fI\,help <command>\/\fR
  17  .SH DESCRIPTION
  18  Limenka Knots RPC client version v29.3.0.knots20260508
  19  .PP
  20  The limenka\-cli utility provides a command line interface to interact with a Limenka Knots RPC server.
  21  .PP
  22  It can be used to query network information, manage wallets, create or broadcast transactions, and control the Limenka Knots server.
  23  .PP
  24  Use the "help" command to list all commands. Use "help <command>" to show help for that command.
  25  The \fB\-named\fR option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters.
  26  .SH OPTIONS
  27  .HP
  28  \fB\-color=\fR<when>
  29  .IP
  30  Color setting for CLI output (default: auto). Valid values: always, auto
  31  (add color codes when standard output is connected to a terminal
  32  and OS is not WIN32), never. Only applies to the output of
  33  \fB\-getinfo\fR.
  34  .HP
  35  \fB\-conf=\fR<file>
  36  .IP
  37  Specify configuration file. Relative paths will be prefixed by datadir
  38  location. (default: limenka.conf)
  39  .HP
  40  \fB\-confrw=\fR<file>
  41  .IP
  42  Specify read/write configuration file. Relative paths will be prefixed
  43  by the network\-specific datadir location. (default:
  44  limenka_rw.conf)
  45  .HP
  46  \fB\-datadir=\fR<dir>
  47  .IP
  48  Specify data directory
  49  .HP
  50  \fB\-help\fR
  51  .IP
  52  Print this help message and exit (also \fB\-h\fR or \-?)
  53  .HP
  54  \fB\-named\fR
  55  .IP
  56  Pass named instead of positional arguments (default: false)
  57  .HP
  58  \fB\-rpcclienttimeout=\fR<n>
  59  .IP
  60  Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
  61  900)
  62  .HP
  63  \fB\-rpcconnect=\fR<ip>
  64  .IP
  65  Send commands to node running on <ip> (default: 127.0.0.1)
  66  .HP
  67  \fB\-rpccookiefile=\fR<loc>
  68  .IP
  69  Location of the auth cookie. Relative paths will be prefixed by a
  70  net\-specific datadir location. (default: data dir)
  71  .HP
  72  \fB\-rpcpassword=\fR<pw>
  73  .IP
  74  Password for JSON\-RPC connections
  75  .HP
  76  \fB\-rpcport=\fR<port>
  77  .IP
  78  Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, testnet4:
  79  48332, signet: 38332, regtest: 18443)
  80  .HP
  81  \fB\-rpcuser=\fR<user>
  82  .IP
  83  Username for JSON\-RPC connections
  84  .HP
  85  \fB\-rpcwait\fR
  86  .IP
  87  Wait for RPC server to start
  88  .HP
  89  \fB\-rpcwaittimeout=\fR<n>
  90  .IP
  91  Timeout in seconds to wait for the RPC server to start, or 0 for no
  92  timeout. (default: 0)
  93  .HP
  94  \fB\-rpcwallet=\fR<walletname>
  95  .IP
  96  Send RPC for non\-default wallet on RPC server (needs to exactly match
  97  corresponding \fB\-wallet\fR option passed to limenkad). This changes
  98  the RPC endpoint used, e.g.
  99  http://127.0.0.1:8332/wallet/<walletname>
 100  .HP
 101  \fB\-stdin\fR
 102  .IP
 103  Read extra arguments from standard input, one per line until EOF/Ctrl\-D
 104  (recommended for sensitive information such as passphrases). When
 105  combined with \fB\-stdinrpcpass\fR, the first line from standard input
 106  is used for the RPC password.
 107  .HP
 108  \fB\-stdinrpcpass\fR
 109  .IP
 110  Read RPC password from standard input as a single line. When combined
 111  with \fB\-stdin\fR, the first line from standard input is used for the
 112  RPC password. When combined with \fB\-stdinwalletpassphrase\fR,
 113  \fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR
 114  consumes the second.
 115  .HP
 116  \fB\-stdinwalletpassphrase\fR
 117  .IP
 118  Read wallet passphrase from standard input as a single line. When
 119  combined with \fB\-stdin\fR, the first line from standard input is used
 120  for the wallet passphrase.
 121  .HP
 122  \fB\-version\fR
 123  .IP
 124  Print version and exit
 125  .PP
 126  Debugging/Testing options:
 127  .PP
 128  Chain selection options:
 129  .HP
 130  \fB\-chain=\fR<chain>
 131  .IP
 132  Use the chain <chain> (default: main). Allowed values: main, test,
 133  testnet4, signet, regtest
 134  .HP
 135  \fB\-signet\fR
 136  .IP
 137  Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
 138  is defined by the \fB\-signetchallenge\fR parameter
 139  .HP
 140  \fB\-signetblocktime\fR
 141  .IP
 142  Difficulty adjustment will target a block time of the given amount in
 143  seconds (only for custom signet networks, must have
 144  \fB\-signetchallenge\fR set; defaults to 10 minutes)
 145  .HP
 146  \fB\-signetchallenge\fR
 147  .IP
 148  Blocks must satisfy the given script to be considered valid (only for
 149  signet networks; defaults to the global default signet test
 150  network challenge)
 151  .HP
 152  \fB\-signetseednode\fR
 153  .IP
 154  Specify a seed node for the signet network, in the hostname[:port]
 155  format, e.g. sig.net:1234 (may be used multiple times to specify
 156  multiple seed nodes; defaults to the global default signet test
 157  network seed node(s))
 158  .HP
 159  \fB\-testnet\fR
 160  .IP
 161  Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3
 162  is deprecated and will be removed in an upcoming release.
 163  Consider moving to testnet4 now by using \fB\-testnet4\fR.
 164  .HP
 165  \fB\-testnet4\fR
 166  .IP
 167  Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR.
 168  .PP
 169  CLI Commands:
 170  .HP
 171  \fB\-addrinfo\fR
 172  .IP
 173  Get the number of addresses known to the node, per network and total,
 174  after filtering for quality and recency. The total number of
 175  addresses known to the node may be higher.
 176  .HP
 177  \fB\-generate\fR
 178  .IP
 179  Generate blocks, equivalent to RPC getnewaddress followed by RPC
 180  generatetoaddress. Optional positional integer arguments are
 181  number of blocks to generate (default: 1) and maximum iterations
 182  to try (default: 1000000), equivalent to RPC generatetoaddress
 183  nblocks and maxtries arguments. Example: limenka\-cli \fB\-generate\fR 4
 184  1000
 185  .HP
 186  \fB\-getinfo\fR
 187  .IP
 188  Get general information from the remote server, including the total
 189  balance and the balances of each loaded wallet when in
 190  multiwallet mode. Note that \fB\-getinfo\fR is the combined result of
 191  several RPCs (getnetworkinfo, getblockchaininfo, getwalletinfo,
 192  getbalances, and in multiwallet mode, listwallets), each with
 193  potentially different state.
 194  .HP
 195  \fB\-netinfo\fR
 196  .IP
 197  Get network peer connection information from the remote server. An
 198  optional argument from 0 to 4 can be passed for different peers
 199  listings (default: 0). If a non\-zero value is passed, an
 200  additional "outonly" (or "o") argument can be passed to see
 201  outbound peers only. Pass "help" (or "h") for detailed help
 202  documentation.
 203  .SH COPYRIGHT
 204  Copyright (C) 2009-2026 The Limenka Knots developers
 205  Copyright (C) 2009-2026 The Limenka developers
 206  
 207  Please contribute if you find Limenka Knots useful. Visit
 208  <https://limenkaknots.org/> for further information about the software.
 209  The source code is available from <https://github.com/limenkaknots/limenka>.
 210  
 211  This is experimental software.
 212  Distributed under the MIT software license, see the accompanying file COPYING
 213  or <https://opensource.org/licenses/MIT>
 214  .SH "SEE ALSO"
 215  limenkad(1), limenka-tx(1), limenka-wallet(1), limenka-util(1), limenka-qt(1)
 216