.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. .TH BITCOIN-CLI "1" "November 2023" "bitcoin-cli v25.1.0" "User Commands" .SH NAME bitcoin-cli \- manual page for bitcoin-cli v25.1.0 .SH SYNOPSIS .B bitcoin-cli [\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Knots\/\fR .br .B bitcoin-cli [\fI\,options\/\fR] \fI\,-named \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Knots (with named arguments)\/\fR .br .B bitcoin-cli [\fI\,options\/\fR] \fI\,help List commands\/\fR .br .B bitcoin-cli [\fI\,options\/\fR] \fI\,help Get help for a command\/\fR .SH DESCRIPTION Bitcoin Knots RPC client version v25.1.0 .SH OPTIONS .HP \-? .IP Print this help message and exit .HP \fB\-addrinfo\fR .IP Get the number of addresses known to the node, per network and total, after filtering for quality and recency. The total number of addresses known to the node may be higher. .HP \fB\-color=\fR .IP Color setting for CLI output (default: auto). Valid values: always, auto (add color codes when standard output is connected to a terminal and OS is not WIN32), never. .HP \fB\-conf=\fR .IP Specify configuration file. Relative paths will be prefixed by datadir location. (default: bitcoin.conf) .HP \fB\-confrw=\fR .IP Specify read/write configuration file. Relative paths will be prefixed by the network\-specific datadir location. (default: bitcoin_rw.conf) .HP \fB\-datadir=\fR .IP Specify data directory .HP \fB\-generate\fR .IP Generate blocks, equivalent to RPC getnewaddress followed by RPC generatetoaddress. Optional positional integer arguments are number of blocks to generate (default: 1) and maximum iterations to try (default: 1000000), equivalent to RPC generatetoaddress nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4 1000 .HP \fB\-getinfo\fR .IP Get general information from the remote server, including the total balance and the balances of each loaded wallet when in multiwallet mode. Note that \fB\-getinfo\fR is the combined result of several RPCs (getnetworkinfo, getblockchaininfo, getwalletinfo, getbalances, and in multiwallet mode, listwallets), each with potentially different state. .HP \fB\-named\fR .IP Pass named instead of positional arguments (default: false) .HP \fB\-netinfo\fR .IP 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). Pass "help" for detailed help documentation. .HP \fB\-rpcclienttimeout=\fR .IP Timeout in seconds during HTTP requests, or 0 for no timeout. (default: 900) .HP \fB\-rpcconnect=\fR .IP Send commands to node running on (default: 127.0.0.1) .HP \fB\-rpccookiefile=\fR .IP Location of the auth cookie. Relative paths will be prefixed by a net\-specific datadir location. (default: data dir) .HP \fB\-rpcpassword=\fR .IP Password for JSON\-RPC connections .HP \fB\-rpcport=\fR .IP Connect to JSON\-RPC on (default: 8332, testnet: 18332, signet: 38332, regtest: 18443) .HP \fB\-rpcuser=\fR .IP Username for JSON\-RPC connections .HP \fB\-rpcwait\fR .IP Wait for RPC server to start .HP \fB\-rpcwaittimeout=\fR .IP Timeout in seconds to wait for the RPC server to start, or 0 for no timeout. (default: 0) .HP \fB\-rpcwallet=\fR .IP Send RPC for non\-default wallet on RPC server (needs to exactly match corresponding \fB\-wallet\fR option passed to bitcoind). This changes the RPC endpoint used, e.g. http://127.0.0.1:8332/wallet/ .HP \fB\-stdin\fR .IP Read extra arguments from standard input, one per line until EOF/Ctrl\-D (recommended for sensitive information such as passphrases). When combined with \fB\-stdinrpcpass\fR, the first line from standard input is used for the RPC password. .HP \fB\-stdinrpcpass\fR .IP Read RPC password from standard input as a single line. When combined with \fB\-stdin\fR, the first line from standard input is used for the RPC password. When combined with \fB\-stdinwalletpassphrase\fR, \fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR consumes the second. .HP \fB\-stdinwalletpassphrase\fR .IP Read wallet passphrase from standard input as a single line. When combined with \fB\-stdin\fR, the first line from standard input is used for the wallet passphrase. .HP \fB\-version\fR .IP Print version and exit .PP Debugging/Testing options: .PP Chain selection options: .HP \fB\-chain=\fR .IP Use the chain (default: main). Allowed values: main, test, signet, regtest .HP \fB\-signet\fR .IP Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network is defined by the \fB\-signetchallenge\fR parameter .HP \fB\-signetblocktime\fR .IP Difficulty adjustment will target a block time of the given amount in seconds (only for custom signet networks, must have \fB\-signetchallenge\fR set; defaults to 10 minutes) .HP \fB\-signetchallenge\fR .IP Blocks must satisfy the given script to be considered valid (only for signet networks; defaults to the global default signet test network challenge) .HP \fB\-signetseednode\fR .IP 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 network seed node(s)) .HP \fB\-testnet\fR .IP Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. .SH COPYRIGHT Copyright (C) 2009-2023 The Bitcoin Core developers Please contribute if you find Bitcoin Knots useful. Visit for further information about the software. The source code is available from . This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING or