bitcoin-cli - manual page for bitcoin-cli v0.30.5
bitcoin-cli [options] <command>
[params] Send command to Bitcoin ABC
bitcoin-cli [options] -named
<command> [name=value]... Send command to
Bitcoin ABC (with named arguments)
bitcoin-cli [options] help List
commands
bitcoin-cli [options] help <command>
Get help for a command
Bitcoin ABC RPC client version v0.30.5
-?
Print this help message and exit
-conf=<file>
Specify configuration file. Relative paths will be prefixed by datadir location. (default: bitcoin.conf)
-datadir=<dir>
Specify data directory
-ecash
Use the eCash prefixes and units (default: true)
-generate
Generate blocks immediately, 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 -generate 4 1000
-getinfo
Get general information from the remote server. Note that unlike server-side RPC calls, the results of -getinfo 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)
-named
Pass named instead of positional arguments (default: false)
-netinfo
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).
-rpcclienttimeout=<n>
Timeout in seconds during HTTP requests, or 0 for no timeout. (default: 900)
-rpcconnect=<ip>
Send commands to node running on <ip> (default: 127.0.0.1)
-rpccookiefile=<loc>
Location of the auth cookie. Relative paths will be prefixed by a net-specific datadir location. (default: data dir)
-rpcpassword=<pw>
Password for JSON-RPC connections
-rpcport=<port>
Connect to JSON-RPC on <port> (default: 8332, testnet: 18332, regtest: 18443)
-rpcuser=<user>
Username for JSON-RPC connections
-rpcwait
Wait for RPC server to start
-rpcwallet=<walletname>
Send RPC for non-default wallet on RPC server (needs to exactly match corresponding -wallet option passed to bitcoind). This changes the RPC endpoint used, e.g. http://127.0.0.1:8332/wallet/<walletname>
-stdin
Read extra arguments from standard input, one per line until EOF/Ctrl-D (recommended for sensitive information such as passphrases). When combined with -stdinrpcpass, the first line from standard input is used for the RPC password.
-stdinrpcpass
Read RPC password from standard input as a single line. When combined with -stdin, the first line from standard input is used for the RPC password. When combined with -stdinwalletpassphrase, -stdinrpcpass consumes the first line, and -stdinwalletpassphrase consumes the second.
-stdinwalletpassphrase
Read wallet passphrase from standard input as a single line. When combined with -stdin, the first line from standard input is used for the wallet passphrase.
-version
Print version and exit
Chain selection options:
-chain=<chain>
Use the chain <chain> (default: main). Allowed values: main, test, regtest
-testnet
Use the test chain. Equivalent to -chain=test.
Copyright (C) 2009-2024 The Bitcoin developers
Please contribute if you find Bitcoin ABC useful. Visit <https://www.bitcoinabc.org> for further information about the software. The source code is available from <https://github.com/Bitcoin-ABC/bitcoin-abc>.
This is experimental software. Distributed under the MIT software license, see the accompanying file COPYING or <https://opensource.org/licenses/MIT>
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by Eric Young and UPnP software written by Thomas Bernard.