You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
163 lines
4.7 KiB
163 lines
4.7 KiB
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13. |
|
.TH BITCOIN-CLI "1" "September 2021" "bitcoin-cli v22.0.0" "User Commands" |
|
.SH NAME |
|
bitcoin-cli \- manual page for bitcoin-cli v22.0.0 |
|
.SH SYNOPSIS |
|
.B bitcoin-cli |
|
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR |
|
.br |
|
.B bitcoin-cli |
|
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (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 <command> Get help for a command\/\fR |
|
.SH DESCRIPTION |
|
Bitcoin Core RPC client version v22.0.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. |
|
.HP |
|
\fB\-conf=\fR<file> |
|
.IP |
|
Specify configuration file. Relative paths will be prefixed by datadir |
|
location. (default: bitcoin.conf) |
|
.HP |
|
\fB\-datadir=\fR<dir> |
|
.IP |
|
Specify data directory |
|
.HP |
|
\fB\-generate\fR |
|
.IP |
|
Generate blocks immediately, 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. Note that unlike |
|
server\-side RPC calls, the results of \fB\-getinfo\fR is the result of |
|
multiple 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) |
|
.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<n> |
|
.IP |
|
Timeout in seconds during HTTP requests, or 0 for no timeout. (default: |
|
900) |
|
.HP |
|
\fB\-rpcconnect=\fR<ip> |
|
.IP |
|
Send commands to node running on <ip> (default: 127.0.0.1) |
|
.HP |
|
\fB\-rpccookiefile=\fR<loc> |
|
.IP |
|
Location of the auth cookie. Relative paths will be prefixed by a |
|
net\-specific datadir location. (default: data dir) |
|
.HP |
|
\fB\-rpcpassword=\fR<pw> |
|
.IP |
|
Password for JSON\-RPC connections |
|
.HP |
|
\fB\-rpcport=\fR<port> |
|
.IP |
|
Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, signet: |
|
38332, regtest: 18443) |
|
.HP |
|
\fB\-rpcuser=\fR<user> |
|
.IP |
|
Username for JSON\-RPC connections |
|
.HP |
|
\fB\-rpcwait\fR |
|
.IP |
|
Wait for RPC server to start |
|
.HP |
|
\fB\-rpcwaittimeout=\fR<n> |
|
.IP |
|
Timeout in seconds to wait for the RPC server to start, or 0 for no |
|
timeout. (default: 0) |
|
.HP |
|
\fB\-rpcwallet=\fR<walletname> |
|
.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/<walletname> |
|
.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<chain> |
|
.IP |
|
Use the chain <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\-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.
|
|
|