The quickest way to bootstrap a blockchain application with the Lisk SDK is explained here.

Supported Operating Systems

The Lisk SDK will run on both the Ubuntu and MacOS operating systems listed below:

  • Ubuntu

  • MacOS

  • 18.04 (LTS)

  • 20.04 (LTS)

  • 10.13 (High Sierra)

  • 10.14 (Mojave)

  • 10.15 (Catalina)

  • 11.04 (Big Sur)

Please note that the SDK does not come with any official support for Windows.


The following dependencies need to be installed to run the Lisk SDK:

Dependencies Version


v2 (latest)


v18 (latest LTS)

Lisk Commander

v5.1.10 (latest)


If you are using NVM, (Node.js Version Manager), ensure you install the correct version as shown below:

nvm install 18

Lisk Commander

It is recommended to install Lisk Commander globally with NPM (Node Package Manager), to facilitate the convenient usage of the Lisk Commander CLI.

npm install --global lisk-commander

Project setup

mkdir new_app
cd new_app
lisk init

The user is asked for the application name, description, author, and license after running lisk init.

Next, all the required files are created by Lisk Commander.

Using template "lisk-ts"
Initializing git repository
Updating .liskrc.json file
Creating project structure
? Application name new_app
? Application description My blockchain application
? Author mona
? License ISC

Start the application

Execute the following command to start the blockchain application.

./bin/run start

To verify that the application has started, check the log messages in the terminal. If the start was successful, the application will enable forging for all genesis delegates and will begin adding new blocks to the blockchain every 10 seconds.

The application CLI offers various commands to conveniently manage your blockchain application.

To see an overview of all the available CLI commands, execute the following commands in the root folder of the application:

./bin/run --help

Using the application CLI globally

To use the application commands globally, create an alias in the .bashrc file.

alias new_app="$HOME/new_app/bin/run" (1)
1 Adjust to the path where your new_app is located.

After updating the .bashrc file, make it directly available in the terminal by executing the following command:

. ~/.bashrc

Now it is possible to conveniently run the application CLI commands from anywhere by referring to the alias.

new_app --help