|
|
|
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
|
|
|
|
|
.TH BITCOIN-CLI "1" "January 2018" "bitcoin-cli v0.16.0.0" "User Commands"
|
|
|
|
|
.SH NAME
|
|
|
|
|
bitcoin-cli \- manual page for bitcoin-cli v0.16.0.0
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Bitcoin Core RPC client version v0.16.0.0
|
|
|
|
|
.SS "Usage:"
|
|
|
|
|
.TP
|
|
|
|
|
bitcoin\-cli [options] <command> [params]
|
|
|
|
|
Send command to Bitcoin Core
|
|
|
|
|
.IP
|
|
|
|
|
bitcoin\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to Bitcoin Core (with named arguments)
|
|
|
|
|
bitcoin\-cli [options] help List commands
|
|
|
|
|
bitcoin\-cli [options] help <command> Get help for a command
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.HP
|
|
|
|
|
\-?
|
|
|
|
|
.IP
|
|
|
|
|
This help message
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-conf=\fR<file>
|
|
|
|
|
.IP
|
|
|
|
|
Specify configuration file (default: bitcoin.conf)
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-datadir=\fR<dir>
|
|
|
|
|
.IP
|
|
|
|
|
Specify data directory
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-getinfo\fR
|
|
|
|
|
.IP
|
|
|
|
|
Get general information from the remote server. Note that unlike
|
|
|
|
|
server\-side RPC calls, the results of \fB\-getinfo\fR 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)
|
|
|
|
|
.PP
|
|
|
|
|
Chain selection options:
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-testnet\fR
|
|
|
|
|
.IP
|
|
|
|
|
Use the test chain
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-regtest\fR
|
|
|
|
|
.IP
|
|
|
|
|
Enter regression test mode, which uses a special chain in which blocks
|
|
|
|
|
can be solved instantly. This is intended for regression testing
|
|
|
|
|
tools and app development.
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-named\fR
|
|
|
|
|
.IP
|
|
|
|
|
Pass named instead of positional arguments (default: false)
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-rpcconnect=\fR<ip>
|
|
|
|
|
.IP
|
|
|
|
|
Send commands to node running on <ip> (default: 127.0.0.1)
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-rpcport=\fR<port>
|
|
|
|
|
.IP
|
|
|
|
|
Connect to JSON\-RPC on <port> (default: 8332 or testnet: 18332)
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-rpcwait\fR
|
|
|
|
|
.IP
|
|
|
|
|
Wait for RPC server to start
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-rpcuser=\fR<user>
|
|
|
|
|
.IP
|
|
|
|
|
Username for JSON\-RPC connections
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-rpcpassword=\fR<pw>
|
|
|
|
|
.IP
|
|
|
|
|
Password for JSON\-RPC connections
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-rpcclienttimeout=\fR<n>
|
|
|
|
|
.IP
|
|
|
|
|
Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
|
|
|
|
|
900)
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-stdinrpcpass\fR
|
|
|
|
|
.TP
|
|
|
|
|
Read RPC password from standard input as a single line.
|
|
|
|
|
When combined
|
|
|
|
|
.IP
|
|
|
|
|
with \fB\-stdin\fR, the first line from standard input is used for the
|
|
|
|
|
RPC password.
|
|
|
|
|
.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\-rpcwallet=\fR<walletname>
|
|
|
|
|
.IP
|
|
|
|
|
Send RPC for non\-default wallet on RPC server (argument is wallet
|
|
|
|
|
filename in bitcoind directory, required if bitcoind/\-Qt runs
|
|
|
|
|
with multiple wallets)
|
|
|
|
|
.SH COPYRIGHT
|
|
|
|
|
Copyright (C) 2009-2018 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>
|
|
|
|
|
|
|
|
|
|
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.
|
