mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-03-25 09:11:57 +01:00
202 lines
6.3 KiB
Groff
202 lines
6.3 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
|
|
.TH BITCOIN-CLI "1" "March 2025" "bitcoin-cli v29.0.0rc2" "User Commands"
|
|
.SH NAME
|
|
bitcoin-cli \- manual page for bitcoin-cli v29.0.0rc2
|
|
.SH SYNOPSIS
|
|
.B bitcoin-cli
|
|
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR]
|
|
.br
|
|
.B bitcoin-cli
|
|
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]...
|
|
.br
|
|
.B bitcoin-cli
|
|
[\fI\,options\/\fR] \fI\,help\/\fR
|
|
.br
|
|
.B bitcoin-cli
|
|
[\fI\,options\/\fR] \fI\,help <command>\/\fR
|
|
.SH DESCRIPTION
|
|
Bitcoin Core RPC client version v29.0.0rc2
|
|
.PP
|
|
The bitcoin\-cli utility provides a command line interface to interact with a Bitcoin Core RPC server.
|
|
.PP
|
|
It can be used to query network information, manage wallets, create or broadcast transactions, and control the Bitcoin Core server.
|
|
.PP
|
|
Use the "help" command to list all commands. Use "help <command>" to show help for that command.
|
|
The \fB\-named\fR option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters.
|
|
.SH OPTIONS
|
|
.HP
|
|
\fB\-color=\fR<when>
|
|
.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. Only applies to the output of
|
|
\fB\-getinfo\fR.
|
|
.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\-help\fR
|
|
.IP
|
|
Print this help message and exit (also \fB\-h\fR or \-?)
|
|
.HP
|
|
\fB\-named\fR
|
|
.IP
|
|
Pass named instead of positional arguments (default: false)
|
|
.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, testnet4:
|
|
48332, 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,
|
|
testnet4, 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 testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3
|
|
is deprecated and will be removed in an upcoming release.
|
|
Consider moving to testnet4 now by using \fB\-testnet4\fR.
|
|
.HP
|
|
\fB\-testnet4\fR
|
|
.IP
|
|
Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR.
|
|
.PP
|
|
CLI Commands:
|
|
.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\-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. Note that unlike
|
|
server\-side RPC calls, the output of \fB\-getinfo\fR is the result of
|
|
multiple non\-atomic requests. Some entries in the output may
|
|
represent results from different states (e.g. wallet balance may
|
|
be as of a different block from the chain state reported)
|
|
.HP
|
|
\fB\-netinfo\fR
|
|
.IP
|
|
Get network peer connection information from the remote server. An
|
|
optional argument from 0 to 4 can be passed for different peers
|
|
listings (default: 0). If a non\-zero value is passed, an
|
|
additional "outonly" (or "o") argument can be passed to see
|
|
outbound peers only. Pass "help" (or "h") for detailed help
|
|
documentation.
|
|
.SH COPYRIGHT
|
|
Copyright (C) 2009-2025 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>
|
|
.SH "SEE ALSO"
|
|
bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1)
|