e6ad8a6220
Tree-SHA512: c2ff50dbb54c42db9d56f1fcb0d8a2ce9c89089254f1a6b6f2aa98959f47699cd72c7771b53490232938b45d9bb030ce7fe08707c62190e68ada0ddbd8b6e13a
164 lines
4.9 KiB
Groff
164 lines
4.9 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
|
|
.TH BITCOIN-CLI "1" "January 2021" "bitcoin-cli v0.21.0.0" "User Commands"
|
|
.SH NAME
|
|
bitcoin-cli \- manual page for bitcoin-cli v0.21.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 v0.21.0.0
|
|
.SH OPTIONS
|
|
.HP
|
|
\-?
|
|
.IP
|
|
Print this help message and exit
|
|
.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 generatenewaddress
|
|
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).
|
|
.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\-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.
|
|
.SH COPYRIGHT
|
|
Copyright (C) 2009-2020 The Bitcoin Core developers
|
|
|
|
Please contribute if you find Bitcoin Core useful. Visit
|
|
<https://bitcoincore.org/> for further information about the software.
|
|
The source code is available from <https://github.com/bitcoin/bitcoin>.
|
|
|
|
This is experimental software.
|
|
Distributed under the MIT software license, see the accompanying file COPYING
|
|
or <https://opensource.org/licenses/MIT>
|