Last modified: 2024-06-12

sidebar_position
0

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 both ways.

Hardware requirements

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

	Minimum	Recommended
System	Windows 10/11 Ubuntu 20.04	Windows 10/11 Ubuntu 20.04
CPU	Dual core	Quad core
Memory	8G	16G
Hard Disk	50G SSD hard drive	100G SSD hard drive

Installing Neo-CLI package

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

On Linux, install the LevelDB and SQLite3 dev packages.

Ubuntu:

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

CentOS:

sudo wget http://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch. rpm 
sudo yum -y install epel-release-latest-9.noarch.rpm 
sudo yum  -y install leveldb-devel libunwind-devel libsqlite3x-devel sqlite3*

If you use RocksDB as the storage, modify config.json, as shown below：

"Storage": { 
   "Engine": "RocksDBStore", 
   "Path": "Data_RocksDB_{0}" 
},

and then enter the following command on ubuntu 18.04：

sudo apt-get install librocksdb-dev

On some versions of Windows Server, install Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019 (x64) first.

If using Windows10/11, 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.

Installing required files

Git clone Neo-CLI source code from GitHub or using the following command:
```
git clone https://github.com/neo-project/neo-node.git 
```
Download LevelDB and unzip the package for later use.
Install the latest version of .NET Core Runtime

Publishing using Visual Studio (Windows)

If you has Visual Studio 2019 or later version installed on your Windows system, this way is recommended:

In Visual Studio, open the project file neo-node.sln.
In the Solution panel, right click neo-cli and select Publish .
Go to the directory where the compiled files are outputted and copy the libleveldb.dll downloaded before to here.

Publishing using command line (Windows/Linux/macOS)

You can also use .NET Core CLI to pubish the project. For more information refer to dotnet publish .

Run the following command in the command line:
```
cd neo-node\neo-cli 
dotnet restore 
dotnet publish -c release -r <RUNTIME_IDENTIFIER> 
```
Where <RUNTIME_IDENTIFIER> should be replaced by the related system platform RID , e.g. win-x64 , linux-x64 , or osx-x64 .
Go to the directory where the compiled files are outputted and copy the libleveldb.dll downloaded before to here.