Particl CLI

Particl-cli is a command-like client. It offers all the essential features, but doesn't include all the advanced bells and whistles of Particl graphical clients. Particl-cli is recommended for advanced users.

Controlled via command line interface, Particl-cli is usually used on remote machines and computers without monitors, e.g. servers and less powerful devices like Raspberry Pi (which make great dedicated staking devices!).

Particl CLI

Particl-cli Feature
:YES: Opensource
:YES: Send/receive public, blind and anon coins
:YES: Staking
:YES: Signing/verifying of messages
:YES: Advanced wallet management, coin control
:NO: Multisignature
:YES: HD Wallet
:NO: Multiple Wallets
:NO: Support Fiat Currencies
Win/macOS/Linux Platform

Everything is executed in particl-cli directory (particl/bin/) by default.

Before you can enter any commands, you need Particld (daemon) to run:

./particld -daemon

Next, you can enter commands you need. Beware as every command starts with ./particl-cli <command> (and NOT ./particld <command>)

  • stop - stop the daemon
  • help - lists all available commands

If you see Error: couldn't connect to server: unknown (code -1) (make sure server is running and you are connecting to the correct RPC port)

You probably have not started ./particld. You cannot run .particldif ./particl-qtis running.

Informative

  • getinfo - general info about your wallet (version, balance, staking balance, network data etc.)
    • getwalletinfo - view balances (total, staking, immature), wallet (un)locked status etc.
    • getbalance - shows your total balance only
    • listtransactions - lists latest transactions
  • getnetworkinfo - about your connection to the network
  • getpeerinfo - info about peer connections
  • getstakinginfo - staking status & stats

Actions

  • getnewaddress - returns your new address
    • listaddressgroupings - lists all used addresses (with balances)
    • listreceivedbyaddress 0 true - returns addresses with zero balance
    • liststealthaddresses - lists stealth (SDT) addresses
  • sendtoaddress <receiver> <amount> <comment> <comment-to> <narration> – sending (public) PART coins

Confidential and anonymous transactions

  • sendparttoblind <stealth address> <amount> – convert public PART to blinded PART coins
  • sendblindtoblind <stealth address> <amount> – sending blinded PART coins (transactions with hidden TX amount)
  • sendblindtopart <stealth address> <amount> – converting blind PART coins back to public PART coins

Unlocking Wallet with enhanced privacy

The RPC command-line client gained a new argument, -stdin to read extra arguments from standard input, one per line until EOF (Ctrl-D). For example:

$ ./particl-cli -stdin   # then press [Enter]
walletpassphrase         # then press [Enter]
"<passphrase>"           # then press [Enter]
<timeout>                # then press [Enter]
true                     # then press [Ctrl-D] here to end input

Standard Wallet unlocking

Unlock wallet (optionally for staking only) for timeout seconds:

$ ./particl-cli walletpassphrase <passphrase> <timeout> [stakingonly]

e.g. walletpassphrase “<my long pass>” 0 true – unlocks the wallet forever (until locked manually or restarted) for staking only

  • long password containing spaces should be “in quotes”
  • 0 = unlocked forever; 10 = for 10 seconds and so on
  • true in the end toggles “for staking only”; if you want your wallet completely unlocked (for sending transactions etc.) you can leave it out

Particld daemon not launching

If you have problems launching particld (e.g. after an update), run the daemon with -reindex parameter:

$ particld -daemon -reindex