Show / Hide Table of Contents

Installing Neo-CLI

You can choose one of the following ways to install Neo-CLI:

  • Install the official Neo-CLI released package

  • or publish Neo-CLI source code from GitHub into an executable file. If you use macOS, this way is highly recommended.

This document will describe the two installation ways.

Hardware requirements

The following table lists the minimum and recommended hardware requirements for the computer running Neo-CLI.

MinimumRecommended
SystemWindows 10
Ubuntu 16.04/18.04
CentOS 7.4/7.6
Windows 10
Ubuntu 16.04/18.04
CentOS 7.4/7.6
CPUDual coreQuad core
Memory8G16G
Hard Disk50G SSD hard drive100G SSD hard drive

Installing the Neo-CLI package

  1. Download the latest Neo-CLI package according to your operating system on Github and unzip it.

  2. On Linux, install the LevelDB and SQLite3 dev packages. For example, on ubuntu 18.04 run the following:

    sudo apt-get install libleveldb-dev sqlite3 libsqlite3-dev libunwind8-dev 
    

    If using Windows, you can skip this step as those files are already included in the installation package.

Publishing from Neo-CLI source code

You can download and compile the Neo-CLI source directly from Github.

Setting up Neo-CLI on Windows

Installing required files

  1. On Windows 10 install .NET Core and .NET Framework .

  2. Git clone Neo-CLI source code from Github or using the following command:

    $ git clone https://github.com/neo-node/neo-cli.git 
    
  3. Download LevelDB and unzip the package for later use.

Building the executable file

Run the following command in the command line:

cd neo-cli
dotnet restore
dotnet publish -c release -r win10-x64
//Enter the directory where the compiled files are stored and copy the libleveldb.dll downloaded before to here.

Setting up Neo-CLI on Linux

Installing required files

  1. On Linux (ubuntu 18.04) install .NET Core Runtime .

  2. Git clone Neo-CLI source code from Github or using the following command:

    $ git clone https://github.com/neo-node/neo-cli.git 
    
  3. Run the following command to install levelDB:

    sudo apt-get install libleveldb-dev sqlite3 libsqlite3-dev 
    

Building the executable file

Run the following command in the command line:

cd neo-cli
dotnet restore
dotnet publish -c release -r linux-x64

Setting up Neo-CLI on macOS

Installing required files

  1. Git clone Neo-CLI source code from Github or use the following commands:

    $ git clone https://github.com/neo-node/neo-cli.git 
    
  2. Download LevelDB and unzip the package for later use.

  3. Install Visual Studio for Mac .

Building the executable file

Run the following in the command line:

cd neo-cli
dotnet restore
dotnet publish -c release -r osx-x64
//Enter the directory where the compiled files are stored and copy the libleveldb.dll downloaded before to here.

What's next?

Configuring and Starting Neo-CLI