What is Lisk Commander?

Logo

Lisk Commander is a command line interface tool designed to be a low entry point, coupled with being the most convenient and user-friendly tool for developers who are looking for an efficient way of coding.

Lisk Commander allows communication from the command line with a remote or local node in order to access and utilise Lisk-related functionalities.

What can be achieved with Lisk Commander?

  • Bootstrapping a blockchain client.

  • Decrypting/encrypting passphrases or messages.

  • Creating new accounts.

  • And much more…​

For further details please see the Command-Line-Interface.

Setup

Dependencies

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

Dependencies Version

Node.js

v16.18.0 (latest LTS)

Pre-installation

Install Node.js

Node.js is supported on most operating systems. Follow the instructions for your operating system on the Node.js downloads page.

NPM is automatically installed along with Node.js.

Verify Node.js installation

Confirm that Node.js and NPM have been successfully installed by executing the following command:

node --version
npm --version

Installation

To install the latest version of Lisk Commander as a global command, install the NPM package as shown below:

npm install --global lisk-commander

Upon successful completion, NPM will add the Lisk Commander executable to your PATH.

Usage

For a full list of all commands and their available options, see the Command-Line-Interface reference. 
$ lisk
Use npx lisk in case you installed Lisk Commander locally.

Type lisk in the command-line to display the command list and general help:

Lisk Commander general help
A command line interface for Lisk

VERSION
  lisk-commander/6.0.0 darwin-x64 node-v16.18.0

USAGE
  $ lisk [COMMAND]

TOPICS
  endpoint    Invokes the provided endpoint.
  generate    Commands relating to the Lisk generator.
  keys        Return keys corresponding to the given passphrase.
  message     Commands relating to user messages.
  passphrase  Commands relating to Lisk passphrases.

COMMANDS
  autocomplete  Display autocomplete installation instructions.
  console       Lisk interactive REPL session to run commands.
  hash-onion    Create hash onions to be used by the forger.
  help          Display help for lisk.
  init          Bootstrap a blockchain client using the Lisk SDK.
  version

Upgrade

To update your global installation to the latest version of Lisk Commander, simply execute the following command:

npm update --global lisk-commander