For the best viewing experience, please turn your phone to portrait mode.

Lisk Commander Documentation

Lisk Commander is a Command Line Interface tool designed to be a low entry point and the most convenient tool for developers who are looking for an efficient way of coding.

Who is Lisk Commander for?

  • Delegates
  • Node operators
  • Contributors to the Lisk codebase
  • Developers using Lisk’s infrastructure
  • Anyone interested in making use of Lisk’s functionality from the command line with ease

Lisk Commander allows you to communicate with a remote or local node and carry out Lisk-related functionality.

What can I do with Lisk Commander?

  • Create a transaction
  • Decrypt/encrypt passphrases or messages
  • Install and manage a node
  • Create accounts
  • Get delegates
  • And many more! View all commands

Table of contents

Versions

Documentation on lisk.io keeps up to date with version updates. The table below provides an overview about the former releases and documentation versions of Lisk Commander.

Version Release date
(yy/mm/dd)
Documentation reference
v2.2.0 19/0x/xx Current version, live on lisk.io/documentation
v2.1.0 19/01/14 Lisk Commander 2.1 docs
v2.0.0 18/11/14 Lisk Commander 2.0 docs
v1.0.0 18/08/13 Lisk Commander 1.0 docs

Setup

Supported Platforms: Platforms with NodeJS versions 8.3 and above.

Pre-Installation

Lisk Commander requires Node.js as the underlying engine for code execution.

Install Node

Node.js is supported on most operating systems. Follow the instructions for your operating system on the Node.js downloads page.
Lisk-Commander requires Node.js versions 8.3 or above.
NPM is automatically installed along with Node.js.

Verify Node installation

Confirm that Node.js and NPM have been successfully installed by running

node --version
npm --version

Installation

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

npm install --global --production lisk-commander

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

Too see usage examples and configuration options, check the Lisk Commander User Guide.
For a full reference of all commands and their available options, check the Command Reference.

Upgrade

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

npm update --global lisk-commander

Contribute to the Codebase

Everyone is invited to contribute to the Lisk Commander codebase. We welcome and appreciate all contributions.

Github

All necessary information can be found on our Lisk Commander Github.

Contribution Guidelines

Please be sure to read and follow our Contribution Guidelines.

Gitter

If you have any further questions please join our Gitter channel.


What's next?
User Guide