Documentation

Kanari Documentation

Kanari CLI

Command-line interface for interacting with the Kanari Network.

Last updated

Kanari CLI

The kanari CLI is the primary tool for managing wallets, sending transactions, querying RPC state, and working with Move packages on Kanari Network.

Installation

Ensure you have built the project and the kanari binary is in your PATH. See the Compile and install guide for details.

Top-level command groups

kanari <COMMAND>
GroupPurpose
clientSend transactions, query balances/objects/transactions, manage RPC environments, and call view functions.
moveBuild, test, document, publish, verify, and call Move packages/functions.
keytoolCreate, import, select, inspect, and list encrypted local wallets.

Node operation commands live in the separate kanari-node binary. See Kanari Node CLI.

RPC endpoint resolution

Most client and on-chain move commands accept:

--rpc <RPC_ENDPOINT>

If --rpc is omitted, the CLI uses the active environment from kanari client envs. If no active environment is configured, it falls back to:

http://127.0.0.1:6767

Use the exact endpoint your node is serving. Some deployments expose JSON-RPC at the host root, while gateway/explorer deployments may expose /rpc.

Commands

client

Client operations: native KANARI transfer, custom token transfer, faucet, burn, stats, balances, owner/object queries, transaction lookup, view calls, stress testing, and environment management.

For a detailed guide on blockchain and token operations, see the Client Operations page.

Example:

kanari client transfer --to <RECIPIENT_ADDRESS> --amount <AMOUNT> --password <PASSWORD>

move

Manage Move packages, tools, and smart contracts.

For a detailed guide on Move development, see the Move Development page.

Example:

kanari move build

keytool

Keytool operations: create, load/select, list, inspect, and import wallets.

For a detailed guide on wallet and key management, see the Keytool Operations page.

Example:

kanari keytool create --password <YOUR_PASSWORD>