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.

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!).

Also check out Partyman staking utility which is a great tool to manage your staking node with ease – it's beginner-friendly and automates many of the tedious tasks related to maintenance of your node!

Browse & compare Particl-cli's features with other available wallets.

Installation

  1. Download latest release latest release
  2. Recommended Verify the downloaded archive (to make sure you haven't downloaded bad client, e.g. infected with malware)
  3. Launch the client – see Usage below
  4. Backup your wallet – see Backup & Restore wallet guide

Backup & Restore

Read our dedicated guide on how to properly and securely back-up (and restore) your Particl wallet.

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

Basic commands

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), you probably haven't started ./particld.

You cannot run ./particld in parallel with Particl Core wallet.

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 (private) addresses
  • sendtoaddress <receiver> <amount> <comment> <comment-to> <narration> – sending (public) PART coins

Confidential Transactions (Blind)

  • 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

Wallet unlocking

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 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

Particl CLI 2019/08/09 16:20

  • tutorial/particl-cli/start.txt
  • Last modified: 2019/08/09 16:20
  • by allien