Skip to main content

Getting Started

This section will guide you through the installation and initial configuration of Helix, providing a step-by-step approach to setting up the environment and configuring the necessary parameters to get the Virtual Machine running on your local system or in a production setting.

Installation​

Before you begin, ensure that your system meets the following prerequisites:

  • Operating System:

    • Linux (Ubuntu 20.04 recommended)

    • MacOS

    • Windows Subsystem for Linux (WSL2)

  • Memory: At least 8 GB of RAM

  • Storage: At least 10 GB of free disk space

Step 1: Clone the Repository​

Start by cloning the Helix repository from GitHub to your local machine. Open a terminal window and run the following command:

git clone git@github.com:Nuklai/nuklaivm-chain.git
cd nuklaivm-chain

  • Checkoutv0.1.0 git tag to use the stable version

  • Checkout main branch to use the latest version

Step 2: Build the Project​

After cloning the repository, build the Helix project to compile the source code into executable binaries:

./scripts/build.sh

This script will handle the compilation of all components required for Helix to run.

Running Helix​

To start Helix, use the following command:

./scripts/run.sh