Skip to main content

Installation

Install the following tools in order to develop and test programs locally:

1. Installing Leo 🦁​

1.1 Install Git​

bit.ly/start-git

1.2 Install Rust​

bit.ly/start-rust

1.3 Install Leo​

Installing Leo by building from the source code as follows:

# Download the source code and initialize the submodules
git clone --recurse-submodules https://github.com/ProvableHQ/leo
cd leo

# Install 'leo'
cargo install --path .

1.4 Verify Installation​

To verify if you have Leo, open your terminal and type leo. You should be able to see the following:

Leo

1.5 Check Version and Update Leo​

To check the version of leo, in your terminal, run:

leo --version

You can update Leo to the latest version using the following command:

leo update

The Leo CLI guide provides descriptions for all of the CLI commands.

The Leo Language guide provides an overview of the syntax and semantics of the Leo programming language.

1.6 Optional: IDE Syntax Highlighting​

Aleo maintains syntax highlighting implementations for various popular code editors. This can significantly enhance your development experience by providing visual cues and making your Leo code more readable. Here's a brief overview of the supported editors:

  1. Visual Studio Code
  2. Sublime Text
  3. Intellij

For detailed instructions on how to set up syntax highlighting for these editors, please refer to the Tooling for Leo guide.

2. Installing snarkOS​

2.1 Prerequisites​

Before beginning, please ensure your machine has Rust v1.79+ installed. Instructions to install Rust can be found here.

2.2 Clone the snarkOS repository​

git clone --branch mainnet --single-branch https://github.com/AleoNet/snarkOS.git

[For Ubuntu users] A helper script to install dependencies is available. From the snarkOS directory, run:

./build_ubuntu.sh

2.3 Install snarkOS​

cd snarkOS
cargo install --locked --path .

2.4 Verify Installation​

To verify if you have snarkOS, open your terminal and type snarkos. You should be able to see the following: snarkOS

3. Next Steps​

tip

We recommend starting with the Quick Start Guide. This guide will walk you through creating your first Aleo application, deploying it to the network, and executing program functions. This hands-on experience will give you a practical understanding of the Aleo platform's core features and workflow.

You now have all of the tools to build and test Leo programs locally. Before deploying to the Testnet, we recommend testing your program using a local network. The following guide explains how to initialize and deploy programs to a local network.