Quick Start

Welcome to Kanari Network. This guide will walk you through the process of building and running the Kanari CLI on your local machine.

Prerequisites

Before you begin, ensure you have the following installed:

• Rust (Stable channel recommended)
• Git

Building the CLI

1. Install Ubuntu & macOS

Install dependencies

sudo apt  install git curl cmake make gcc lld pkg-config libssl-dev libclang-dev libsqlite3-dev g++ protobuf-compiler

Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Clone the repository

git clone git clone https://github.com/kanari-network/kanari-sdk.git

Compile and install kanari CLI

kanari and kanari-node

cd kanari-sdk
cargo build --release

# kanari
cp target/release/kanari ~/.cargo/bin
# kanari-node
cp target/release/kanari-node ~/.cargo/bin

2. Install Windows

Install dependencies

To compile kanari on Windows, you'll need to install the following dependencies:

1. Build Tools for Visual Studio 2022
2. LLVM
3. Git

Install Rust

1. Download the Rust installer from the official Rust website.
2. Run the installer and follow the on-screen instructions.
3. After installation, open a new Command Prompt or PowerShell window and verify the installation by running:

rustc --version

Clone the repository

git clone https://github.com/kanari-network/kanari-sdk.git

Compile and install Kari

cd kanari-sdk
cargo build --release

# kanari
cp target/release/kanari ~/.cargo/bin
# kanari-node
cp target/release/kanari-node ~/.cargo/bin

Running the CLI

Once built, you can use the CLI to interact with the network.

List Wallets

To see the list of available wallets and their balances:

cargo run -p kanari -- list-wallets

Note: On the first run, the CLI will perform a genesis process to initialize the local database located at ~/.kari/kanari-db/.

Move VM Integration

Kanari Network leverages the Move VM. You can run Move subcommands directly through the Kanari CLI:

# Create a new Move package
cargo run -p kanari -- move new <package-name>

# Run tests for a Move package
cargo run -p kanari -- move test <path-to-move-package>