mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-01-20 15:19:07 +01:00
d3bd5410f6
Tree-SHA512: 361c6efdd21396ebf4358195e91bde81e7f7414e7022efc4d4a10da7cf3df7ce8cdadd277237921fdde9bae4b811d69d95fec56c010b823324ca69b40b966d41
164 lines
4.6 KiB
Groff
164 lines
4.6 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
|
|
.TH BITCOIN-CLI "1" "August 2021" "bitcoin-cli v22.0rc2" "User Commands"
|
|
.SH NAME
|
|
bitcoin-cli manual page for bitcoin-cli v22.0rc2
|
|
.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.0rc2
|
|
.SH OPTIONS
|
|
.HP
|
|
?
|
|
.IP
|
|
Print this help message and exit
|
|
.HP
|
|
\fBaddrinfo\fR
|
|
.IP
|
|
Get the number of addresses known to the node, per network and total.
|
|
.HP
|
|
\fBconf=\fR<file>
|
|
.IP
|
|
Specify configuration file. Relative paths will be prefixed by datadir
|
|
location. (default: bitcoin.conf)
|
|
.HP
|
|
\fBdatadir=\fR<dir>
|
|
.IP
|
|
Specify data directory
|
|
.HP
|
|
\fBgenerate\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: bitcoincli \fBgenerate\fR 4
|
|
1000
|
|
.HP
|
|
\fBgetinfo\fR
|
|
.IP
|
|
Get general information from the remote server. Note that unlike
|
|
serverside RPC calls, the results of \fBgetinfo\fR is the result of
|
|
multiple nonatomic 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
|
|
\fBnamed\fR
|
|
.IP
|
|
Pass named instead of positional arguments (default: false)
|
|
.HP
|
|
\fBnetinfo\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
|
|
\fBrpcclienttimeout=\fR<n>
|
|
.IP
|
|
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
|
|
900)
|
|
.HP
|
|
\fBrpcconnect=\fR<ip>
|
|
.IP
|
|
Send commands to node running on <ip> (default: 127.0.0.1)
|
|
.HP
|
|
\fBrpccookiefile=\fR<loc>
|
|
.IP
|
|
Location of the auth cookie. Relative paths will be prefixed by a
|
|
netspecific datadir location. (default: data dir)
|
|
.HP
|
|
\fBrpcpassword=\fR<pw>
|
|
.IP
|
|
Password for JSONRPC connections
|
|
.HP
|
|
\fBrpcport=\fR<port>
|
|
.IP
|
|
Connect to JSONRPC on <port> (default: 8332, testnet: 18332, signet:
|
|
38332, regtest: 18443)
|
|
.HP
|
|
\fBrpcuser=\fR<user>
|
|
.IP
|
|
Username for JSONRPC connections
|
|
.HP
|
|
\fBrpcwait\fR
|
|
.IP
|
|
Wait for RPC server to start
|
|
.HP
|
|
\fBrpcwaittimeout=\fR<n>
|
|
.IP
|
|
Timeout in seconds to wait for the RPC server to start, or 0 for no
|
|
timeout. (default: 0)
|
|
.HP
|
|
\fBrpcwallet=\fR<walletname>
|
|
.IP
|
|
Send RPC for nondefault wallet on RPC server (needs to exactly match
|
|
corresponding \fBwallet\fR option passed to bitcoind). This changes
|
|
the RPC endpoint used, e.g.
|
|
http://127.0.0.1:8332/wallet/<walletname>
|
|
.HP
|
|
\fBstdin\fR
|
|
.IP
|
|
Read extra arguments from standard input, one per line until EOF/CtrlD
|
|
(recommended for sensitive information such as passphrases). When
|
|
combined with \fBstdinrpcpass\fR, the first line from standard input
|
|
is used for the RPC password.
|
|
.HP
|
|
\fBstdinrpcpass\fR
|
|
.IP
|
|
Read RPC password from standard input as a single line. When combined
|
|
with \fBstdin\fR, the first line from standard input is used for the
|
|
RPC password. When combined with \fBstdinwalletpassphrase\fR,
|
|
\fBstdinrpcpass\fR consumes the first line, and \fBstdinwalletpassphrase\fR
|
|
consumes the second.
|
|
.HP
|
|
\fBstdinwalletpassphrase\fR
|
|
.IP
|
|
Read wallet passphrase from standard input as a single line. When
|
|
combined with \fBstdin\fR, the first line from standard input is used
|
|
for the wallet passphrase.
|
|
.HP
|
|
\fBversion\fR
|
|
.IP
|
|
Print version and exit
|
|
.PP
|
|
Debugging/Testing options:
|
|
.PP
|
|
Chain selection options:
|
|
.HP
|
|
\fBchain=\fR<chain>
|
|
.IP
|
|
Use the chain <chain> (default: main). Allowed values: main, test,
|
|
signet, regtest
|
|
.HP
|
|
\fBsignet\fR
|
|
.IP
|
|
Use the signet chain. Equivalent to \fBchain\fR=\fI\,signet\/\fR. Note that the network
|
|
is defined by the \fBsignetchallenge\fR parameter
|
|
.HP
|
|
\fBsignetchallenge\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
|
|
\fBsignetseednode\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
|
|
\fBtestnet\fR
|
|
.IP
|
|
Use the test chain. Equivalent to \fBchain\fR=\fI\,test\/\fR.
|