monero-wallet-cli - Reference¶

Overview¶

Command line wallet¶

The "official" command line wallet for Monero. Available for Linux, macOS and Windows.

Wallet uses your private keys to understand your total balance, transactions history, and to facilitate creating transactions.

However, wallet does not store the blockchain and does not directly participate in the p2p network.

The CLI wallet is the most reliable and most feature complete wallet for Monero.

Depends on the full node¶

Wallet connects to a full node to scan the blockchain for your transaction outputs and to send your transactions out to the network.

The full node can be either local (same computer) or remote.

Normally, you run the full node on the same computer as wallet (or within your home network).

Connection happens over HTTP and uses this API.

Any transaction leaving the wallet is already blinded by all Monero privacy features. This means plain text HTTP communication isn't an issue on its own even if you connect to a remote node.

However, connecting to a remote node has other nuanced trade-offs, which is a topic for a separate article.

Syntax¶

./monero-wallet-cli [options] [command]

Example:

./monero-wallet-cli --stagenet

Running¶

Go to directory where you unpacked Monero.

Run the full node and wait until it syncs up with the network (may take up to a few days):

./monerod --stagenet

In a separate terminal window, run the wallet:

./monero-wallet-cli --stagenet --generate-new-wallet MoneroExampleStagenetWallet

Options¶

Help and version¶

Pick network¶

Logging¶

Full node connection¶

Wallet depends on a full node for all non-local operations. The following options define how to connect to monerod:

Create new wallet¶

Open existing wallet¶

Restore wallet¶

Option	Description
--generate-from-device <arg>	Restore/generate a special wallet to work with a hardware device like Ledger or Trezor and save it to <arg> file. Note: --subaddress-lookahead can only be set during wallet creation or restore Example: ./monero-wallet-cli --stagenet --generate-from-device MoneroExampleDeviceWallet --subaddress-lookahead 5:20 This is a one-time action. Next time you simply open the wallet. By default the command expects Ledger hardware connected. For Trezor hardware add --hw-device Trezor (expected ~May 2019). It will take up to 25 minutes with default settings. This is because hardware devices are slow to pre-generate subaddresses. To mitigate use low --subaddress-lookahead 5:20. The local wallet will not have private spend key and will not be able to spend on its own. It serves as a user interface and a bridge for low-power hardware devices. Transaction signing with a private spend key always happens on the hardware device. See the complete guide to hardware wallet setup.
--generate-from-view-key <arg>	Restore a view-only version of the wallet to track incoming transactions and save it to <arg> file. The wallet is created based on a secret view key and standard address. The secret view key is meant to be pasted as hexadecimal.
--generate-from-spend-key <arg>	Restore a wallet from secret spend key and save it to <arg> file. The secret spend key is meant to be pasted as hexadecimal.
--restore-deterministic-wallet	Restore a wallet from secret mnemonic seed. Use this to restore from your 25 words backup. You will be asked for a password to encrypt the wallet file (once restored). Note this is not a passphrase to mnemonic seed. Mnemonic seeds generated by Monero official wallets are naked.
--restore-height <arg>	Only scan for transactions later than specific blockchain height. The default is 0. Raising the value makes wallet restoration radically faster. The optimal value should match the day you originally created the wallet (but cannot be later). The mapping between the block height and date/time is available on block explorers like https://xmrchain.net. For instance, if you created the wallet in 2019+ use 1730000.

Multisig wallet¶

Config file¶

Performance¶

Option	Description
--subaddress-lookahead <arg>	Note: This flag can only be set during wallet creation or restore Accepts m:n, by default 50:200. The first value is the number of accounts and the second value is the number of subaddresses per account. The wallet will not check for payments to subaddresses further than n away from the last received payment. This can happen if you generated unique subaddresses for n clients in a row but none of them paid. On the other hand the more subaddresses you set to look ahead, the longer it takes to create your wallet, because they must be pre-computed. This is normally not a concern, except for hardware wallets. On the Ledger the default value of 50:200 can take over 20 minutes (one time on wallet creation)!
--max-concurrency <arg>	Max number of threads to use for parallel jobs. The default value 0 uses the number of CPU threads.

Internationalization¶

Legacy¶

These options are either legacy or rarely useful.

Defaults¶

Wallet files are created and seek in current directory. This is rarely what you want. Use --wallet-file and similar options to control this.

Log files are created in the same directory as monero-wallet-cli binary. Use --log-file to specify the location.

Commands¶

Commands are used interactively in the monero-wallet-cli prompt.

You can also run a one-off command by providing it as a commandline parameter. This is rarely useful though. For automation prefer monero-wallet-rpc.

The CLI wallet has built-in help for individual commands - we will not attempt to reproduce that. Instead we focus on grouping commands so you can quickly find what you are looking for. Use help command_name to learn more.

Help and version¶

help - list all commands

help command_name - show help for individual command

version - show version of the monero-wallet-cli binary

Network status¶

status - show if synced up to the blockchain height

fee - show current fee-per-byte and full node's mempool (the backlog of transactions depending on the priority)

wallet_info - show wallet file path, standard address, type and network

Balance¶

account - total balance; list accounts with respective balances

balance detail - within the current account, list addresses with respective balances

refresh - force refresh the balance and transactions by pulling latest blocks from the full node; this is often useful because auto-refresh only kicks in once in 90 seconds

Manage accounts¶

account

account new

account switch

account label

Manage addresses¶

address all

address new

address label

View transactions¶

show_transfers - show all transactions on the current account; optionally provide a filter: in | out | pending | failed | pool | coinbase; optionally provide subaddress index for output selection

show_transfer <txid> - show details of specific transaction

incoming_transfers [available|unavailable] [verbose] [index=<N1>[,<N2>[,...]]] - show the incoming transactions, all or filtered by availability and address index within current account; this will only show confirmed transactions; you will not see transactions awaiting in the mempool

get_tx_note <txid> - get a string note for transaction id

export_transfers [in|out|all|pending|failed|pool|coinbase] [index=<N1>[,<N2>,...]] [<min_height> [<max_height>]] [output=<filepath>] [option=<with_keys>] - exports a list of all transfer information to a CSV file. You can filter by type [in|out|all|pending|failed|pool|coinbase], by index, by minimum and maximum block height, specify the output path for the CSV file, and optionally include the tx private keys (if available) with the export.

Keys and Passwords¶

Secret mnemonic seed¶

seed - show raw mnemonic seed

encrypted_seed - create mnemonic seed encrypted with the passphrase; you will need to remember or store the passphrase separately; restoring will not be possible without the passphrase

Secret keys¶

spendkey - show secret spend key and public spend key

viewkey - show secret view key and public view key

Wallet password¶

password - change wallet password; this password is used to encrypt the local wallet files; it does not change secret keys or backups

Proofs¶

get_reserve_proof -> check_reserve_proof - prove the balance

get_spend_proof -> check_spend_proof - prove you made the payment

sign <file> -> verify <filename> <address> <signature> - prove ownership of the address; allows to verify the file was signed by the owner of specific Monero address

get_tx_proof -> check_tx_proof

Multisig¶

Setup¶

prepare_multisig

make_multisig

finalize_multisig

Update¶

export_multisig_info

import_multisig_info

Other¶

submit_multisig

exchange_multisig_keys

export_raw_multisig_tx

sign_multisig <filename>

Hardware wallet¶

hw_reconnect - attempts to reconnect HW wallet

Mining¶

start_mining

stop_mining

Advanced¶

Outputs¶

unspent_outputs - show a list of, and a histogram of unspent outputs (indivisible pieces of your total balance)

export_outputs <file> -> import_outputs <file> - helps with cold spending; export outputs from a view-wallet to the cold-wallet to make it aware of what had been sent to it

mark_output_spent <amount>/<offset> | <filename> [add] - "blackball"/mark an output known to be spent, so that it will no longer be selected as a decoy

mark_output_unspent <amount>/<offset> - unmark an output not known to be spent, so that it will possibly be selected as a decoy

is_output_spent <amount>/<offset>

Key images¶

export_key_images <file> -> import_key_images <file> - used to inform the view-only wallet about outgoing transactions so it can calculate the real balance; normally view-only wallets only learn about incoming transactions, not outgoing

Tx private key¶

These allow to learn and verify transaction's private key r. This was useful to create a proof of payment but got superseded by get_spend_proof.

get_tx_key <txid>

check_tx_key <txid> <txkey> <address>

set_tx_key <txid> <tx_key>

Debugging¶

rescan_spent - rescan the blockchain for spent outputs; sometimes, the wallet's idea of what outputs are spent and what outputs are not get out of sync with the blockchain. This can happen if you exit the wallet without saving after sending a tx, or if it crashes. This will look for the key images on the blockchain to make sure it's up to date.

Cosmetics¶

donate <amount> - donate <amount> to development team

address_book [(add ((<address> [pid <id>])|<integrated address>) [<description possibly with whitespaces>])|(delete <index>)]

set_description [free text note] -> get_description - manage convenience description of the wallet (the information is local)

Legacy¶

save - this now happens automatically

save_bc - this now happens automatically

bc_height - show blockchain height (superseded with status)

sweep_unmixable - only relevant for very old wallets (<= 2016); send all unmixable outputs to yourself with ring_size 10

locked_sweep_all - see

rescan_bc - rescan the blockchain from scratch, losing any information which can not be recovered from the blockchain itself

TODO: document remaining commands