lisk-commander

Lisk Commander

Lisk Commander allows you to communicate with a remote or local node and carry out Lisk-related functionality using an interactive or non-interactive command line tool.

Prerequisites

Lisk Commander requires Node.js as the underlying engine for code execution. Node.js is supported on most operating systems. Follow the instructions for your operating system on the Node.js downloads page. You will need version 6.11.x or higher. NPM is automatically installed along with Node.js.

Installation

From NPM

$ npm install --global --production lisk-commander

Upon successful completion, NPM will add the lisk-commander executable to your PATH.

From Source

Clone the Lisk Commander repository using Git and install the dependencies:

$ git clone https://github.com/LiskHQ/lisk-commander.git
$ cd lisk-commander
$ npm install

Before running the executable you will need to build Lisk Commander:

npm run build

Adding the Lisk Commander executable to your PATH

WARNING: If you have installed Lisk Commander globally via NPM (see Install Lisk Commander via NPM), following the instructions in this section is not recommended as they will introduce conflicts.

If you would like to add the lisk executable to your PATH you have two options: option 1 will install the current state of the code you are installing globally, while option 2 will only link to the code and therefore automatically reflect changes you make going forward.

1. Install globally

Running this command from within the repository will add Lisk Commander to your global NPM packages, and add the lisk executable to your PATH. Be aware that any previous globally installed Lisk Commander version will get overridden with this local version.

$ npm install --global --production

Note that you will have to repeat this process for each subsequent build of Lisk Commander.

2. Create a symlink

The other option is to ask NPM to create a symlink in the global folder that links to the package.

$ npm link

This will also add lisk to your PATH, but you won't have to repeat the process if you pull or create a new build. Be aware that any previous globally installed Lisk Commander version will get overridden with this local version.

Usage

Interactive use

To run commands interactively:

$ lisk
 _      _     _       _____                                          _
| |    (_)   | |     / ____|                                        | |
| |     _ ___| | __ | |     ___  _ __ ___  _ __ ___   __ _ _ __   __| | ___ _ __
| |    | / __| |/ / | |    / _ \| '_ ` _ \| '_ ` _ \ / _` | '_ \ / _` |/ _ \ '__|
| |____| \__ \   <  | |___| (_) | | | | | | | | | | | (_| | | | | (_| |  __/ |
|______|_|___/_|\_\  \_____\___/|_| |_| |_|_| |_| |_|\__,_|_| |_|\__,_|\___|_|

Running v1.0.0.
Type `help` to get started.

lisk> help

  Commands:

    help [command...]                    Provides help for a given command.
    exit                                 Exits Lisk Commander.
    env                                  Print environmental configuration.
    get [options] <type> <input>         Get information from <type> with parameter <input>.
                                         Types available: account, address, block, delegate, transaction
                                         E.g. get delegate lightcurve
                                         e.g. get block 5510510593472232540
    list [options] <type> <variadic...>  Get information from <type> with parameters <input, input, ...>.
                                         Types available: accounts, addresses, blocks, delegates, transactions
                                         E.g. list delegates lightcurve tosch
                                         E.g. list blocks 5510510593472232540 16450842638530591789
    set <variable> <value>               Set configuration <variable> to <value>. Configuration is
                                         persisted in `~/.lisk-commander/config.json`.
lisk>

Non-interactive use

To run commands and options directly from the command line:

$ lisk get delegate lightcurve --json

Settings

Configuration is stored in a config file placed in the user's home directory (run help set to see the exact location). If this is unavailable a default configuration is used. The following settings can be updated (and will be persisted if possible):

Command	Description
set name lisk	Sets name to be displayed.
set delimiter lisk	Sets delimiter in interactive mode.
set json true|false	Sets default to JSON output (true) or text output (false).
set pretty true|false	Sets default to formatted output when JSON output is used.
set api.network main|test|beta	Sets API target to the specified network.
set api.nodes http://localhost:4000 http://192.168.178.1:4001	Override api.network and set specific nodes communicate to.

Documentation

Further information can be found on our documentation site:

• Introduction
• Pre-Installation
• Installation
  • Install-from-NPM
  • Install-from-Source
• Upgrading
  • Upgrading-from-NPM
  • Upgrading-from-Source
• Usage
  • Configuration
  • Usage
  • Commands

Get Involved

Lisk Commander is an open-source project and all contributions are welcome.

If you find a bug or want to make feature request, please create an issue with as much detail as you can.

Run Tests

Lisk Commander has an extensive set of unit tests. To run the tests, please install Lisk Commander from source, and then run the command:

$ npm test

FAQ

Why won’t Lisk Commander start with my version of Node.js?

You try to run Lisk Commander and it tells you ERROR: Requires Node.js version 6.14.1, but was started with version 8.11.1.

Because of the sensitive nature of Lisk Commander’s functionality, we want to make absolutely sure that when our users are using Lisk Commander it behaves as expected. Currently we only perform substantial tests with a single version of Node.js, so we require our users to use that specific version to avoid unforeseen behavior discrepancies.

In the future we would like to support a wider range of Node.js versions, but until then we recommend using a Node.js version manager, such as nvm, to make it easy to switch between different Node.js versions.

Why do I get an error regarding a config lockfile?

You try to run Lisk Commander and it tells you Config lockfile at ~/.lisk-commander/config.lock found. Are you running Lisk Commander in another process?

When you start Lisk Commander, either in interactive or non-interactive-mode, we create a lockfile to prevent you from making changes to your configuration file. If for some reason either Lisk Commander or your computer crashes, this lockfile might not be removed, and Lisk Commander will prevent you from starting a new instance even though no Lisk Commander instance is currently running. In this case it’s safe to remove the lockfile.

The lockfile is located in your Lisk Commander configuration directory. The error message above will give you the location of the file if you want to remove if manually, or you can run lisk clean and Lisk Commander will remove it for you.

Something else went wrong. What should I do?

1. Make sure you’re on the network you intend to be on.
2. Exit Lisk Commander (if in interactive mode) and restart.
3. Remove the configuration file (config.json) located in your Lisk Commander configuration directory (~/.lisk-commander by default). When you restart Lisk Commander the default configuration will be recreated.
4. Get in contact on Lisk Chat or Gitter.
5. If it seems like a bug, open an issue on GitHub. See the Contribution Guidelines.

Contributors

https://github.com/LiskHQ/lisk-commander/graphs/contributors

License

Copyright © 2017–2018 Lisk Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.