PARTICL-CLI(1)

📦
version 23.2.10.0 · 2 versions
, in nixpkgs unstable

🌸 PARTICL-CLI(1) — the particl-cli manual, but make it make sense 💅

okay bestie, so this is the manual page for particl-cli, and it's sitting at version v23.2.10.0 — think of this whole page as the group chat where your terminal talks to Particl Core. no cap, it's genuinely useful. let's go 🫶

✨ NAME ✨

particl-cli — the manual page for particl-cli v23.2.10.0. that's it, that's the name section, she's short and iconic 💖

✨ SYNOPSIS ✨

four ways to slide into the CLI's DMs, so pick your vibe:

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

lowkey the help variants are your besties when you forget a command name — help alone lists everything, help <command> zooms in on one 🌈

✨ DESCRIPTION ✨

Particl Core RPC client version v23.2.10.0. literally that's the whole description, she's a woman of few words and honestly? respect 😌

✨ OPTIONS ✨

okay so here's the full menu, no skips, no "you'll figure it out" — every single one is below 👑

  • ? — print this help message and exit. the most chaotic-named option ever and yet so real.
  • addrinfo — get the number of addresses known to the node, per network and total, after filtering for quality and recency. heads up: the total number of addresses known to the node may be higher than what you see here, so don't come for her about the math 🧮
  • color=<when> — color setting for CLI output (default: auto). valid values: always, auto (add color codes when standard output is connected to a terminal and OS is not WIN32), never.
  • conf=<file> — specify configuration file. relative paths will be prefixed by datadir location. (default: particl.conf)
  • datadir=<dir> — specify data directory.
  • generate — generate blocks, 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:
particlcli generate 4 1000
  • getinfo — get general information from the remote server. ⚠️ note that unlike serverside RPC calls, the results of getinfo is the result of multiple nonatomic 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). it's giving "screenshot of a live feed", not a frozen moment 📸
  • 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). 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 node running on <ip> (default: 127.0.0.1).
  • rpccookiefile=<loc> — location of the auth cookie. relative paths will be prefixed by a netspecific datadir location. (default: data dir)
  • rpcpassword=<pw> — password for JSONRPC connections.
  • rpcport=<port> — connect to JSONRPC on <port> (default: 51735, testnet: 51935, signet: 31932, regtest: 51936). yes those are four different numbers, write them down bestie 📝
  • rpcuser=<user> — username for JSONRPC connections.
  • rpcwait — wait for RPC server to start. she's patient, she'll wait 💜
  • 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 nondefault wallet on RPC server (needs to exactly match corresponding wallet option passed to particld). this changes the RPC endpoint used, e.g. http://127.0.0.1:51735/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. 🎯 order matters, don't mix them up
  • 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.

🧪 Debugging/Testing options:

(this subsection exists in the manual, but nothing is listed under it — so there's literally nothing to tell you here. iconic empty-verse energy ✨)

⛓️ Chain selection options:

chain=<chain>

use the chain <chain> (default: main). allowed values: main, test, signet, regtest.

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.

copyright (C) 2017-2025 The Particl Core developers. copyright (C) 2009-2022 The Bitcoin Core developers 💖

please contribute if you find Particl Core useful. visit <https://particl.io/> for further information about the software. the source code is available from <https://github.com/particl/particl-core>.

⚠️ real talk: this is experimental software. distributed under the MIT software license, see the accompanying file COPYING or <https://opensource.org/licenses/MIT>. experimental means experimental, bestie — don't put your whole life savings in a vibe check 🙈

and that's the page! 🎀 this was particl-cli v23.2.10.0, dated June 2026 — go forth and RPC responsibly, mwah 💋🌈

📦 where this page comes from