Inside Bitcoin

1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
2.TH BITCOIN-CLI "1" "October 2026" "bitcoin-cli v32.1.0" "User Commands"
3.SH NAME
4bitcoin-cli \- manual page for bitcoin-cli v32.1.0
5.SH SYNOPSIS
6.B bitcoin-cli
7[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR]
8.br
9.B bitcoin-cli
10[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]...
11.br
12.B bitcoin-cli
13[\fI\,options\/\fR] \fI\,help\/\fR
14.br
15.B bitcoin-cli
16[\fI\,options\/\fR] \fI\,help <command>\/\fR
17.SH DESCRIPTION
18Bitcoin Core RPC client version v32.1.0
19.PP
20The bitcoin\-cli utility provides a command line interface to interact with a Bitcoin Core RPC server.
21.PP
22It can be used to query network information, manage wallets, create or broadcast transactions, and control the Bitcoin Core server.
23.PP
24Use the "help" command to list all commands. Use "help <command>" to show help for that command.
25The \fB\-named\fR option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters.
26.SH OPTIONS
27.HP
28\fB\-color=\fR<when>
29.IP
30Color setting for CLI output (default: auto). Valid values: always, auto
31(add color codes when standard output is connected to a terminal
32and OS is not WIN32), never. Only applies to the output of
33\fB\-getinfo\fR.
34.HP
35\fB\-conf=\fR<file>
36.IP
37Specify configuration file. Relative paths will be prefixed by datadir
38location. (default: bitcoin.conf)
39.HP
40\fB\-datadir=\fR<dir>
41.IP
42Specify data directory
43.HP
44\fB\-help\fR
45.IP
46Print this help message and exit (also \fB\-h\fR or \-?)
47.HP
48\fB\-named\fR
49.IP
50Pass named instead of positional arguments (default: false)
51.HP
52\fB\-rpcclienttimeout=\fR<n>
53.IP
54Timeout in seconds during HTTP requests, or 0 for no timeout. Not
55implemented for IPC connections (see \fB\-ipcconnect\fR). (default: 900)
56.HP
57\fB\-rpcconnect=\fR<ip>
58.IP
59Send commands to node running on <ip> (default: 127.0.0.1)
60.HP
61\fB\-rpccookiefile=\fR<loc>
62.IP
63Location of the auth cookie. Relative paths will be prefixed by a
64net\-specific datadir location. (default: data dir)
65.HP
66\fB\-rpcid=\fR<id>
67.IP
68Set a custom JSON\-RPC request ID string (default: 1)
69.HP
70\fB\-rpcpassword=\fR<pw>
71.IP
72Password for JSON\-RPC connections
73.HP
74\fB\-rpcport=\fR<port>
75.IP
76Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, testnet4:
7748332, signet: 38332, regtest: 18443)
78.HP
79\fB\-rpcuser=\fR<user>
80.IP
81Username for JSON\-RPC connections
82.HP
83\fB\-rpcwait\fR
84.IP
85Wait for RPC server to start
86.HP
87\fB\-rpcwaittimeout=\fR<n>
88.IP
89Timeout in seconds to wait for the RPC server to start, or 0 for no
90timeout. (default: 0)
91.HP
92\fB\-rpcwallet=\fR<walletname>
93.IP
94Send RPC for non\-default wallet on RPC server (needs to exactly match
95corresponding \fB\-wallet\fR option passed to bitcoind). This changes
96the RPC endpoint used, e.g.
97http://127.0.0.1:8332/wallet/<walletname>
98.HP
99\fB\-stdin\fR
100.IP
101Read extra arguments from standard input, one per line until EOF/Ctrl\-D
102(recommended for sensitive information such as passphrases). When
103combined with \fB\-stdinrpcpass\fR, the first line from standard input
104is used for the RPC password.
105.HP
106\fB\-stdinrpcpass\fR
107.IP
108Read RPC password from standard input as a single line. When combined
109with \fB\-stdin\fR, the first line from standard input is used for the
110RPC password. When combined with \fB\-stdinwalletpassphrase\fR,
111\fB\-stdinrpcpass\fR consumes the first line, and \fB\-stdinwalletpassphrase\fR
112consumes the second.
113.HP
114\fB\-stdinwalletpassphrase\fR
115.IP
116Read wallet passphrase from standard input as a single line. When
117combined with \fB\-stdin\fR, the first line from standard input is used
118for the wallet passphrase.
119.HP
120\fB\-version\fR
121.IP
122Print version and exit
123.PP
124Debugging/Testing options:
125.PP
126Chain selection options:
127.HP
128\fB\-chain=\fR<chain>
129.IP
130Use the chain <chain> (default: main). Allowed values: main, test,
131testnet4, signet, regtest
132.HP
133\fB\-signet\fR
134.IP
135Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
136is defined by the \fB\-signetchallenge\fR parameter
137.HP
138\fB\-signetchallenge\fR
139.IP
140Blocks must satisfy the given script to be considered valid (only for
141signet networks; defaults to the global default signet test
142network challenge)
143.HP
144\fB\-signetseednode\fR
145.IP
146Specify a seed node for the signet network, in the hostname[:port]
147format, e.g. sig.net:1234 (may be used multiple times to specify
148multiple seed nodes; defaults to the global default signet test
149network seed node(s))
150.HP
151\fB\-testnet\fR
152.IP
153Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3
154is deprecated and will be removed in an upcoming release.
155Consider moving to testnet4 now by using \fB\-testnet4\fR.
156.HP
157\fB\-testnet4\fR
158.IP
159Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR.
160.PP
161CLI Commands:
162.HP
163\fB\-addrinfo\fR
164.IP
165Get the number of addresses known to the node, per network and total.
166.HP
167\fB\-generate\fR
168.IP
169Generate blocks, equivalent to RPC getnewaddress followed by RPC
170generatetoaddress. Optional positional integer arguments are
171number of blocks to generate (default: 1) and maximum iterations
172to try (default: 1000000), equivalent to RPC generatetoaddress
173nblocks and maxtries arguments. Example: bitcoin\-cli \fB\-generate\fR 4
1741000
175.HP
176\fB\-getinfo\fR
177.IP
178Get general information from the remote server. Note that unlike
179server\-side RPC calls, the output of \fB\-getinfo\fR is the result of
180multiple non\-atomic requests. Some entries in the output may
181represent results from different states (e.g. wallet balance may
182be as of a different block from the chain state reported)
183.HP
184\fB\-netinfo\fR
185.IP
186Get network peer connection information from the remote server. An
187optional argument from 0 to 4 can be passed for different peers
188listings (default: 0). If a non\-zero value is passed, an
189additional "outonly" (or "o") argument can be passed to see
190outbound peers only. Pass "help" (or "h") for detailed help
191documentation.
192.PP
193IPC interprocess connection options:
194.HP
195\fB\-ipcconnect=\fR<address>
196.IP
197Connect to bitcoin\-node through IPC socket instead of TCP socket to
198execute requests. Valid <address> values are 'auto' to try to
199connect to default socket path at <datadir>/node.sock but fall
200back to TCP if it is not available, 'unix' to connect to the
201default socket and fail if it isn't available, or 'unix:<socket
202path>' to connect to a socket at a nonstandard path.
203\fB\-noipcconnect\fR can be specified to avoid attempting to use IPC at
204all. Default value: auto
205.SH COPYRIGHT
206Copyright (C) 2009-2026 The Bitcoin Core developers
207
208Please contribute if you find Bitcoin Core useful. Visit
209<https://bitcoincore.org/> for further information about the software.
210The source code is available from <https://github.com/bitcoin/bitcoin>.
211
212This is experimental software.
213Distributed under the MIT software license, see the accompanying file COPYING
214or <https://opensource.org/license/MIT>
215.SH "SEE ALSO"
216bitcoin(1), bitcoind(1), bitcoin-cli(1), bitcoin-tx(1), bitcoin-wallet(1), bitcoin-util(1), bitcoin-qt(1)
217