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