Install Nillion SDK and Tools
- Mac and Linux
- Windows
Mac and Linux Guide
1. Install nilup, the Nillion SDK tool installer and version manager.
Nillion SDK binaries are available for Linux and macOS platforms. For Windows installation, make sure to follow our Windows developer environment setup guide ahead of installing binaries.
For the security-conscious, please download the install.sh script, so that you can inspect how
it works, before piping it to bash.
curl https://nilup.nilogy.xyz/install.sh | bash
Close your terminal. Open a new terminal and confirm global nilup tool installation
nilup -V
// Your output should be similar to the below
nilup 22c84830fff3c86beec27a8cb6353d45e7bfb8a4
2. Use nilup to install the latest version of the Nillion SDK.
nilup install latest
nilup use latest
nilup init
Optionally enable nilup telemetry, providing your Ethereum wallet address. We collect this data to understand how the software is used, and to better assist you in case of issues. In doing this, you consent to the collection of telemetry data by the Nillion Network. While we will not collect any personal information, we still recommend using a new wallet address that cannot be linked to your identity by any third party.
For more information, check out our privacy policy.
nilup instrumentation enable --wallet <your-eth-wallet-address>
Close your terminal. Open a new terminal and confirm global Nillion tool installation with
nillion -V
// Your output should be similar to the below
nilup 22c84830fff3c86beec27a8cb6353d45e7bfb8a4
Windows Guide
Today Nillion SDK binaries are available for Mac and Linux. In order to install Nillion on a Windows machine, you'll need to first complete a 5 minute WSL developer environment setup. Follow the steps below to install WSL, set up your WSL developer environment, and install and use Nillion Linux binaries from a Windows machine.
WSL developer environment setup
The Windows Subsystem for Linux (WSL) lets developers install a Linux distribution and use Linux applications, utilities, and Bash command-line tools including the Nillion SDK and tools on a Windows machine.
1. Run the install command
From your terminal, install WSL
wsl --install
This downloads and installs the Ubuntu Linux distribution.
2. Restart your computer
A reboot is required after installing Ubuntu.
3. After restarting, open Ubuntu and create an account
To open an Ubuntu terminal, search for the app from Start. Open Ubuntu and follow the prompts to set up your Linux username and password.
4. Update and upgrade packages
sudo apt update && sudo apt upgrade
5. Install the Visual Studio Code Remote Development Extension
Visual Studio Code Remote Development allows you to use a container, remote machine, or the Windows Subsystem for Linux (WSL) as a full-featured development environment. Install the Visual Studio Code Remote Development Extension Pack.
6. Open a new Ubuntu terminal and Install Nillion
Now that your WSL development environment is set up, you can install the Nillion SDK and Tools.
Make sure to install Nillion within a new Ubuntu terminal. Either open a Ubuntu terminal, or from your Windows PowerShell terminal, first run Ubuntu:
ubuntu
Installation
1. Install nilup, the Nillion SDK tool installer and version manager.
Nillion SDK binaries are available for Linux and macOS platforms. For Windows installation, make sure to follow our Windows developer environment setup guide ahead of installing binaries.
For the security-conscious, please download the install.sh script, so that you can inspect how
it works, before piping it to bash.
curl https://nilup.nilogy.xyz/install.sh | bash
Close your terminal. Open a new terminal and confirm global nilup tool installation
nilup -V
// Your output should be similar to the below
nilup 22c84830fff3c86beec27a8cb6353d45e7bfb8a4
2. Use nilup to install the latest version of the Nillion SDK.
nilup install latest
nilup use latest
nilup init
Optionally enable nilup telemetry, providing your Ethereum wallet address. We collect this data to understand how the software is used, and to better assist you in case of issues. In doing this, you consent to the collection of telemetry data by the Nillion Network. While we will not collect any personal information, we still recommend using a new wallet address that cannot be linked to your identity by any third party.
For more information, check out our privacy policy.
nilup instrumentation enable --wallet <your-eth-wallet-address>
Close your terminal. Open a new terminal and confirm global Nillion tool installation with
nillion -V
// Your output should be similar to the below
nilup 22c84830fff3c86beec27a8cb6353d45e7bfb8a4
🎉 Great work! You've set up a WSL environment and installed Nillion within that environment. Before running a nillion command like nillion-devnet, nada, or pynadac make sure you are in a WSL environment by first running ubuntu:
ubuntu