ELEMENTS-CLI(1)

📦
version 23.3.4 · 2 versions
, in nixpkgs unstable

💅 ELEMENTS-CLI — the manual page, but make it make sense

okay so this is the man page for elements-cli (that's the User Commands one, bestie, in case you were wondering which manual section you wandered into) ✨

🌸 NAME 🌸

elements-cli — manual page for elements-cli v23.3.4. that's it, that's the name section, she's short and sweet 💖

🦋 SYNOPSIS 🦋

elements-cli [options] <command> [params]  Send command to Elements Core
elements-cli [options] -named <command> [name=value]...  Send command to
Elements Core (with named arguments)
elements-cli [options] help                List commands
elements-cli [options] help <command>      Get help for a command

like, four whole ways to talk to your node. pick your fighter 🫶

🎀 DESCRIPTION 🎀

Elements Core RPC client version v23.3.4. that's literally the whole description and honestly? iconic minimalism 💅

✨ OPTIONS ✨

  • -? — prints this help message and dips. that's it. bye 👋
  • -addrinfo — gets you the number of addresses the node knows about, broken down per network and as a total, after filtering for quality and recency. heads up though: the total number of addresses the node knows may actually be higher than what you see. lowkey mysterious of it.
  • -color=<when> — color setting for CLI output (default: auto). valid values: always, auto (adds color codes when standard output is connected to a terminal and the OS is not WIN32), never. pick your aesthetic 🎨
  • -conf=<file> — specify the configuration file. relative paths get prefixed by the datadir location. (default: elements.conf)
  • -datadir=<dir> — specify the data directory. your stuff lives here 🏠
  • -generate — generate blocks, which is equivalent to the RPC getnewaddress followed by the RPC generatetoaddress. optional positional integer arguments are the number of blocks to generate (default: 1) and the maximum iterations to try (default: 1000000), equivalent to the RPC generatetoaddress nblocks and maxtries arguments. example: bitcoin-cli -generate 4 1000 — yes bestie, the example really does say bitcoin-cli, i don't make the rules 🙈
  • -getinfo — get general information from the remote server. note that unlike server-side RPC calls, the results of -getinfo are the result of multiple non-atomic requests. some entries in the result may represent results from different states (e.g. the wallet balance may be as of a different block from the chain state reported). so like, don't treat it as one perfect snapshot, mkay? 😭
  • -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 peer listings (default: 0). pass "help" for detailed help documentation.
  • -rpcclienttimeout=<n> — timeout in seconds during HTTP requests, or 0 for no timeout. (default: 900)
  • -rpcconnect=<ip> — send commands to the 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: 7041, testnet: 18332, signet: 38332, regtest: 18443)
  • -rpcuser=<user> — username for JSON-RPC connections
  • -rpcwait — wait for the RPC server to start. patience is a virtue etc etc ⏳
  • -rpcwaittimeout=<n> — timeout in seconds to wait for the RPC server to start, or 0 for no timeout. (default: 0)
  • -rpcwallet=<walletname> — send RPC for a non-default wallet on the RPC server (needs to exactly match the corresponding -wallet option passed to elementsd). 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 the 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. line order matters, don't get it twisted 💀
  • -stdinwalletpassphrase — read the 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

🧪 Debugging/Testing options:

(that's genuinely all it says here — the heading, then straight into the next heading. she's a little empty, but we respect her 🫶)

⛓️ Chain selection options:

  • -chain=<chain> — use the chain <chain> (default: liquidv1). reserved values: main, test, signet, regtest, liquidv1, liquidv1test, liquidtestnet
  • -con_blockheightinheader — whether the chain includes the block height directly in the header, for easier validation of block height in low-resource environments. (default: 1)
  • -con_has_parent_chain — whether or not there is a parent chain.
  • -con_max_block_sig_size — max allowed witness data for the signed block header.
  • -con_parent_chain_signblockscript — whether the parent chain uses pow or signed blocks. if the parent chain uses signed blocks, the challenge (scriptPubKey) script. if not, an empty string. (default: empty script [ie parent uses pow])
  • -con_parentpowlimit — the proof-of-work limit value for the parent chain.
  • -con_signed_blocks — signed blockchain. uses input of -signblockscript to define what signatures are necessary to solve it.
  • -fedpegscript — the script for the federated peg enforce from genesis block. this script may stop being enforced once dynamic federations activates. 👀
  • -parentgenesisblockhash — the genesis blockhash of the parent chain.
  • -signblockscript — signed blockchain enumberance. only active when -con_signed_blocks is set to true. (yes, "enumberance" — that's how the original spells it, i'm not touching it 💀)
  • -signet — use the signet chain. equivalent to -chain=signet. note that the network is defined by the -signetchallenge parameter
  • -signetchallenge — blocks must satisfy the given script to be considered valid (only for signet networks; defaults to the global default signet test network challenge)
  • -signetseednode — specify a seed node for the signet network, in the hostname[:port] format, e.g. sig.net:1234 (may be used multiple times to specify multiple seed nodes; defaults to the global default signet test network seed node(s))
  • -testnet — use the test chain. equivalent to -chain=test.

💜 Elements Options:

  • -acceptunlimitedissuances — allow unblinded issuance amounts to exceed 21 million units
  • -con_blocksubsidy — defines the amount of block subsidy to start with, at genesis block, in satoshis.
  • -con_connect_genesis_outputs — connect outputs in genesis block to utxo database.
  • -con_csv_deploy_start — starting height for CSV deployment. (default: -1, which means ACTIVE from genesis)
  • -con_dyna_deploy_signal — whether to signal for the Dynamic Federations deployment (default: 1).
  • -con_elementsmode — use Elements-like instead of Core-like witness encoding. this is required for CA/CT. (default: 1)
  • -con_mandatorycoinbase — all non-zero valued coinbase outputs must go to this scriptPubKey, if set.
  • -dynamic_epoch_length — per-chain parameter that sets how many blocks dynamic federation voting and enforcement are in effect for.
  • -enforce_pak — causes standardness checks to enforce Pegout Authorization Key (PAK) validation before dynamic federations, and consensus enforcement after.
  • -multi_data_permitted — allow relay of multiple OP_RETURN outputs. (default: -enforce_pak)
  • -pak — sets the 'first extension space' field to the pak entries ala pre-dynamic federations. only used for testing in custom chains.
  • -total_valid_epochs — per-chain parameter that sets how long a particular fedpegscript is in effect for.

Copyright (C) 2009-2026 The Elements Project developers Copyright (C) 2009-2026 The Bitcoin Core developers

please contribute if you find Elements Core useful!! visit <https://elementsproject.org/> for further information about the software. the source code is available from <https://github.com/ElementsProject/elements>. 🫶

⚠️ real talk: this is experimental software. distributed under the MIT software license, see the accompanying file COPYING or <https://opensource.org/licenses/MIT>

🌈 the cute sign-off 🌈

and that's the whole page, bestie!! this was elements-cli v23.3.4, dated September 2026, and it ate. literally no crumbs. go forth and RPC responsibly 💖✨🎀🦋🌸💅

📦 where this page comes from