Skip to main content

CLI Guide

What is the Ark Wallet CLI?​

The Ark Wallet CLI (Command Line Interface) is a powerful tool that allows users to interact with the Ark protocol directly from their terminal. It provides a streamlined way to manage your Ark wallet, conduct transactions, and interact with Ark Servers without the need for a graphical interface.

Installation​

Begin by downloading a compatible binary from the latest GitHub releases.

Setting Permissions​

Move the binary to a location in your PATH and make it executable:

mv <binary> /usr/local/bin/ark
chmod +x /usr/local/bin/ark

Wallet Setup and Server Connection​

Initialize your wallet and connect to a liquidity provider running an arkd server:

ark init --password <password> --server-url <server_url>

To restore a wallet, use the --prvkey flag with the hex-encoded private key.

Basic Operations​

Check Balance​

View your onchain and offchain balances:

ark balance

For balance with VTXO expiration details:

ark balance --expiry-details

Receive Funds​

Display your boarding and offchain receiving addresses:

ark receive

Making Payments​

tip

You can send to both onchain and offchain addresses. The CLI will use the appropriate balance.

Send payments to one or multiple receivers co-signing only with the Server and delivering the pending payment to te recipient through the Server:

ark send --to <address> --amount <amount>
ark send --receivers '[{"to": "<address>", "amount": <amount>}, ...]'

Settle Boarding UTXOs​

The settle command can be used to settle your out-of-round VTXOs or to complete the onboarding procedure and join the Ark with your own funds.

ark settle

Redeem an ark-note​

The redeem-notes command can be used to redeem ark-notes.

ark redeem-notes --note <ark-note>

Redeeming Funds on-chain​

Collaborative Redemption​

info

Change from this operation goes to your offchain address.

Work with the Server to redeem funds onchain:

ark redeem --amount <amount> --address <onchain_address>

Unilateral Redemption​

info

The --force flag ignores --address and --amount and redeems all funds.

If the Server is unresponsive, redeem all offchain funds:

ark redeem --force

Help​

For a list of all available commands:

ark help

Creating a Second CLI Instance​

To run a second CLI instance, use a different data directory:

export ARK_WALLET_DATADIR=path/to/custom
ark init --network testnet --password <password> --server-url <server_url>
info

Default data directories:

  • POSIX (Linux/BSD): ~/.Ark-cli
  • Mac OS: $HOME/Library/Application Support/Ark-cli
  • Windows: %LOCALAPPDATA%\Ark-cli
  • Plan 9: $home/Ark-cli