GROESTLCOIN-CLI(1)

📦 version 29.0, in nixos 26.05

🎀 GROESTLCOIN-CLI(1) 🎀

okay so bestie, this is the manual page for groestlcoin-cli 💅 it's a User Commands situation, and the whole thing is literally the group chat between you and your Groestlcoin node. pull up a chair, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

groestlcoin-cli — the manual page for groestlcoin-cli v29.0.0. yes that's the version, no cap, v29.0.0, she's that girl 💖

🌸 SYNOPSIS 🌸

the four moods of groestlcoin-cli, iconically:

groestlcoin-cli [options] <command> [params]
groestlcoin-cli [options] -named <command> [name=value]...
groestlcoin-cli [options] help
groestlcoin-cli [options] help <command>

🦋 DESCRIPTION 🦋

this is the Groestlcoin Core RPC client, version v29.0.0 ⭐ (yes, the version again — she said it twice, she's confident).

the groestlcoin-cli utility is literally your command line interface for talking to a Groestlcoin Core RPC server 🫶 it's giving "direct line to the main character."

you can use it to query network information, manage wallets, create or broadcast transactions, and control the Groestlcoin Core server. all of it. the whole vibe check 👑

use the help command to list all commands. use help <command> to show help for that specific command 📖 the -named option lets you specify parameters using the key=value format, which eliminates the need to pass unused positional parameters — genuinely such a slay, no more awkward empty placeholders 😭

💜 OPTIONS 💜

okay this is the long part, but bestie, we do not skip options in this house. all of them. every single one. let's go ✨

  • -color=<when> — color setting for CLI output, default is auto. valid values are always, auto (which adds color codes when standard output is connected to a terminal and the OS is not WIN32), and never. heads up: this only applies to the output of -getinfo 🎨
  • -conf=<file> — specify the configuration file. relative paths get prefixed by the datadir location. (default: groestlcoin.conf) 🗂️
  • -datadir=<dir> — specify the data directory 📁
  • -help — print this help message and exit. also works as -h or -? (three icons in one, honestly 💅)
  • -named — pass named instead of positional arguments (default: false) 🏷️
  • -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 get prefixed by a net-specific datadir location. (default: data dir) 🍪 (a literal cookie, iconic)
  • -rpcpassword=<pw> — password for JSON-RPC connections 🔐
  • -rpcport=<port> — connect to JSON-RPC on <port> (default: 1441, testnet: 17766, testnet4: 41441, signet: 31441, regtest: 18443) 🚪
  • -rpcuser=<user> — username for JSON-RPC connections 👤
  • -rpcwait — wait for the RPC server to start ⏳
  • -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. this needs to exactly match the corresponding -wallet option passed to groestlcoind. it changes the RPC endpoint used, e.g. http://127.0.0.1:1441/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. team work, fr fr 🤝
  • -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 the heading. there are no options listed under it in the original, and we are not inventing any, iykyk 💀)

⛓️ Chain selection options:

  • -chain=<chain> — use the chain <chain> (default: main). allowed values: main, test, testnet4, 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. it may be used multiple times to specify multiple seed nodes; defaults to the global default signet test network seed node(s) 🌱
  • -testnet — use the testnet3 chain. equivalent to -chain=test. ⚠️ support for testnet3 is deprecated and will be removed in an upcoming release. consider moving to testnet4 now by using -testnet4. (she's retiring, bestie, don't get attached 😭)
  • -testnet4 — use the testnet4 chain. equivalent to -chain=testnet4 🆕

🖥️ CLI Commands:

  • -addrinfo — get the number of addresses known to the node, per network and total, after filtering for quality and recency. the total number of addresses known to the node may be higher. 📊
  • -generate — generate blocks, 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: 100000000), equivalent to the RPC generatetoaddress nblocks and maxtries arguments. example: groestlcoin-cli -generate 4 1000000 ⛏️
  • -getinfo — get general information from the remote server. note that unlike server-side RPC calls, the output of -getinfo is the result of multiple non-atomic requests. some entries in the output may represent results from different states (e.g. wallet balance may be as of a different block from the chain state reported) 🧠
  • -netinfo — get network peer connection information from the remote server. an optional argument from 0 to 4 can be passed for different peers listings (default: 0). if a non-zero value is passed, an additional outonly (or o) argument can be passed to see outbound peers only. pass help (or h) for detailed help documentation 🕸️

copyright (C) 2014-2025 The Groestlcoin Core developers, and copyright (C) 2009-2025 The Bitcoin Core developers 🫶

please contribute if you find Groestlcoin Core useful 💖 visit <https://groestlcoin.org/> for further information about the software. the source code is available from <https://github.com/Groestlcoin/groestlcoin> 📦

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

👀 SEE ALSO 👀

go read your sisters, they're all iconic in their own way 💅✨

and that's the whole page, bestie 🎀 sign-off time: this was groestlcoin-cli v29.0.0, dated April 2025 — you're welcome, go touch some blocks 🌸🦋💖

📦 where this page comes from