1BITCOIN-CLI(1) User Commands BITCOIN-CLI(1)
2
6 bitcoin-cli - manual page for bitcoin-cli v24.0.1
7
9 bitcoin-cli [options] <command> [params] Send command to Bitcoin Core
10 bitcoin-cli [options] -named <command> [name=value]... Send command to
11 Bitcoin Core (with named arguments)
12 bitcoin-cli [options] help List commands
13 bitcoin-cli [options] help <command> Get help for a command
14
16 Bitcoin Core RPC client version v24.0.1
17
19 -?
20 Print this help message and exit
22 -addrinfo
24 Get the number of addresses known to the node, per network and
26 total, after filtering for quality and recency. The total number
27 of addresses known to the node may be higher.
28 -color=<when>
30 Color setting for CLI output (default: auto). Valid values: al‐
32 ways, auto (add color codes when standard output is connected to
33 a terminal and OS is not WIN32), never.
34 -conf=<file>
36 Specify configuration file. Relative paths will be prefixed by
38 datadir location. (default: bitcoin.conf)
39 -datadir=<dir>
41 Specify data directory
43 -generate
45 Generate blocks, equivalent to RPC getnewaddress followed by RPC
47 generatetoaddress. Optional positional integer arguments are
48 number of blocks to generate (default: 1) and maximum iterations
49 to try (default: 1000000), equivalent to RPC generatetoaddress
50 nblocks and maxtries arguments. Example: bitcoin-cli -generate 4
51 1000
52 -getinfo
54 Get general information from the remote server. Note that unlike
56 server-side RPC calls, the results of -getinfo is the result of
57 multiple non-atomic requests. Some entries in the result may
58 represent results from different states (e.g. wallet balance may
59 be as of a different block from the chain state reported)
60 -named
62 Pass named instead of positional arguments (default: false)
64 -netinfo
66 Get network peer connection information from the remote server.
68 An optional integer argument from 0 to 4 can be passed for dif‐
69 ferent peers listings (default: 0). Pass "help" for detailed
70 help documentation.
71 -rpcclienttimeout=<n>
73 Timeout in seconds during HTTP requests, or 0 for no timeout.
75 (default: 900)
76 -rpcconnect=<ip>
78 Send commands to node running on <ip> (default: 127.0.0.1)
80 -rpccookiefile=<loc>
82 Location of the auth cookie. Relative paths will be prefixed by
84 a net-specific datadir location. (default: data dir)
85 -rpcpassword=<pw>
87 Password for JSON-RPC connections
89 -rpcport=<port>
91 Connect to JSON-RPC on <port> (default: 8332, testnet: 18332,
93 signet: 38332, regtest: 18443)
94 -rpcuser=<user>
96 Username for JSON-RPC connections
98 -rpcwait
100 Wait for RPC server to start
102 -rpcwaittimeout=<n>
104 Timeout in seconds to wait for the RPC server to start, or 0 for
106 no timeout. (default: 0)
107 -rpcwallet=<walletname>
109 Send RPC for non-default wallet on RPC server (needs to exactly
111 match corresponding -wallet option passed to bitcoind). This
112 changes the RPC endpoint used, e.g. http://127.0.0.1:8332/wal‐
113 let/<walletname>
114 -stdin
116 Read extra arguments from standard input, one per line until
118 EOF/Ctrl-D (recommended for sensitive information such as
119 passphrases). When combined with -stdinrpcpass, the first line
120 from standard input is used for the RPC password.
121 -stdinrpcpass
123 Read RPC password from standard input as a single line. When
125 combined with -stdin, the first line from standard input is used
126 for the RPC password. When combined with -stdinwalletpassphrase,
127 -stdinrpcpass consumes the first line, and -stdinwallet‐
128 passphrase consumes the second.
129 -stdinwalletpassphrase
131 Read wallet passphrase from standard input as a single line.
133 When combined with -stdin, the first line from standard input is
134 used for the wallet passphrase.
135 -version
137 Print version and exit
139 Debugging/Testing options:
141 Chain selection options:
143 -chain=<chain>
145 Use the chain <chain> (default: main). Allowed values: main,
147 test, signet, regtest
148 -signet
150 Use the signet chain. Equivalent to -chain=signet. Note that the
152 network is defined by the -signetchallenge parameter
153 -signetchallenge
155 Blocks must satisfy the given script to be considered valid
157 (only for signet networks; defaults to the global default signet
158 test network challenge)
159 -signetseednode
161 Specify a seed node for the signet network, in the host‐
163 name[:port] format, e.g. sig.net:1234 (may be used multiple
164 times to specify multiple seed nodes; defaults to the global de‐
165 fault signet test network seed node(s))
166 -testnet
168 Use the test chain. Equivalent to -chain=test.
170
172 Copyright (C) 2009-2022 The Bitcoin Core developers
173 Please contribute if you find Bitcoin Core useful. Visit <https://bit‐
175 coincore.org/> for further information about the software. The source
176 code is available from <https://github.com/bitcoin/bitcoin>.
177 This is experimental software. Distributed under the MIT software li‐
179 cense, see the accompanying file COPYING or <https://opensource.org/li‐
180 censes/MIT>
181bitcoin-cli v24.0.1 December 2022 BITCOIN-CLI(1)