11.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2- .TH BITCOIN-CLI "1" "December 2024 " "bitcoin-cli v28.1.0" "User Commands"
2+ .TH BITCOIN-CLI "1" "March 2025 " "bitcoin-cli v28.1.0" "User Commands"
33.SH NAME
44bitcoin-cli \- manual page for bitcoin-cli v28.1.0
55.SH SYNOPSIS
66.B bitcoin-cli
7- [\fI \, options \/ \fR ] \fI \, <command> \/ \fR [\fI \, params \/ \fR ] \fI \, Send command to Bitcoin Core \/ \fR
7+ [\fI \, options \/ \fR ] \fI \, <command> \/ \fR [\fI \, params \/ \fR ]
88.br
99.B bitcoin-cli
10- [\fI \, options \/ \fR ] \fI \, -named <command> \/ \fR [\fI \, name=value \/ \fR ]... \fI \, Send command to Bitcoin Core (with named arguments) \/ \fR
10+ [\fI \, options \/ \fR ] \fI \, -named <command> \/ \fR [\fI \, name=value \/ \fR ]...
1111.br
1212.B bitcoin-cli
13- [\fI \, options \/ \fR ] \fI \, help List commands \/ \fR
13+ [\fI \, options \/ \fR ] \fI \, help \/ \fR
1414.br
1515.B bitcoin-cli
16- [\fI \, options \/ \fR ] \fI \, help <command> Get help for a command \/ \fR
16+ [\fI \, options \/ \fR ] \fI \, help <command> \/ \fR
1717.SH DESCRIPTION
18- Bitcoin Core RPC client version v28.1.0
18+ Bitcoin Knots RPC client version v28.1.0
19+ .PP
20+ The bitcoin\- cli utility provides a command line interface to interact with a bitcoind/bitcoin\- qt RPC server.
21+ .PP
22+ It can be used to query network information, manage wallets, create or broadcast transactions, and control the bitcoind 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.
1926.SH OPTIONS
2027.HP
2128\- ?
@@ -32,13 +39,20 @@ addresses known to the node may be higher.
3239.IP
3340Color setting for CLI output (default: auto). Valid values: always, auto
3441(add color codes when standard output is connected to a terminal
35- and OS is not WIN32), never.
42+ and OS is not WIN32), never. Only applies to the output of
43+ \fB \- getinfo \fR .
3644.HP
3745\fB \- conf= \fR <file>
3846.IP
3947Specify configuration file. Relative paths will be prefixed by datadir
4048location. (default: bitcoin.conf)
4149.HP
50+ \fB \- confrw= \fR <file>
51+ .IP
52+ Specify read/write configuration file. Relative paths will be prefixed
53+ by the network\- specific datadir location. (default:
54+ bitcoin_rw.conf)
55+ .HP
4256\fB \- datadir= \fR <dir>
4357.IP
4458Specify data directory
@@ -54,11 +68,12 @@ nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4
5468.HP
5569\fB \- getinfo \fR
5670.IP
57- Get general information from the remote server. Note that unlike
58- server\- side RPC calls, the output of \fB \- getinfo \fR is the result of
59- multiple non\- atomic requests. Some entries in the output may
60- represent results from different states (e.g. wallet balance may
61- be as of a different block from the chain state reported)
71+ Get general information from the remote server, including the total
72+ balance and the balances of each loaded wallet when in
73+ multiwallet mode. Note that \fB \- getinfo \fR is the combined result of
74+ several RPCs (getnetworkinfo, getblockchaininfo, getwalletinfo,
75+ getbalances, and in multiwallet mode, listwallets), each with
76+ potentially different state.
6277.HP
6378\fB \- named \fR
6479.IP
@@ -67,8 +82,10 @@ Pass named instead of positional arguments (default: false)
6782\fB \- netinfo \fR
6883.IP
6984Get network peer connection information from the remote server. An
70- optional integer argument from 0 to 4 can be passed for different
71- peers listings (default: 0). Pass "help" for detailed help
85+ optional argument from 0 to 4 can be passed for different peers
86+ listings (default: 0). If a non\- zero value is passed, an
87+ additional "outonly" (or "o") argument can be passed to see
88+ outbound peers only. Pass "help" (or "h") for detailed help
7289documentation.
7390.HP
7491\fB \- rpcclienttimeout= \fR <n>
@@ -153,6 +170,12 @@ testnet4, signet, regtest
153170Use the signet chain. Equivalent to \fB \- chain \fR =\fI \, signet \/ \fR . Note that the network
154171is defined by the \fB \- signetchallenge \fR parameter
155172.HP
173+ \fB \- signetblocktime \fR
174+ .IP
175+ Difficulty adjustment will target a block time of the given amount in
176+ seconds (only for custom signet networks, must have
177+ \fB \- signetchallenge \fR set; defaults to 10 minutes)
178+ .HP
156179\fB \- signetchallenge \fR
157180.IP
158181Blocks must satisfy the given script to be considered valid (only for
@@ -176,14 +199,15 @@ Consider moving to testnet4 now by using \fB\-testnet4\fR.
176199.IP
177200Use the testnet4 chain. Equivalent to \fB \- chain \fR =\fI \, testnet4 \/ \fR .
178201.SH COPYRIGHT
179- Copyright (C) 2009-2024 The Bitcoin Core developers
202+ Copyright (C) 2009-2025 The Bitcoin Knots developers
203+ Copyright (C) 2009-2025 The Bitcoin Core developers
180204
181- Please contribute if you find Bitcoin Core useful. Visit
182- <https://bitcoincore .org/> for further information about the software.
183- The source code is available from <https://github.com/bitcoin /bitcoin>.
205+ Please contribute if you find Bitcoin Knots useful. Visit
206+ <https://bitcoinknots .org/> for further information about the software.
207+ The source code is available from <https://github.com/bitcoinknots /bitcoin>.
184208
185209This is experimental software.
186210Distributed under the MIT software license, see the accompanying file COPYING
187211or <https://opensource.org/licenses/MIT>
188212.SH "SEE ALSO"
189- bitcoind(1), bitcoin-cli(1), bitcoin- tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1)
213+ bitcoind(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1)
0 commit comments