🐱 A command line interface for Lisk
Clone or download
Permalink
Failed to load latest commit information.
bin 🔥 Remove unused dependencies and files Jul 9, 2018
docs Merge branch '2.0.0' of https://github.com/LiskHQ/lisky into development Oct 11, 2018
src ♻️ Update stdin functions and tests Oct 8, 2018
test ♻️ Update stdin functions and tests Oct 8, 2018
.babelrc 🌱 Add object spread plugin and change test structure Jul 16, 2018
.editorconfig Fill out editorconfig Jul 12, 2017
.eslintignore Add coverage and dist dirs to .eslintignore Jul 13, 2017
.eslintrc.json 💅 Update eslint settings Feb 27, 2018
.gitignore ♻️ Remove unused files and clean formatting Jul 9, 2018
.lintstagedrc.json ♻️ update setting files to follow standards Feb 14, 2018
.npmrc 🌱 Add oclif setup Jul 9, 2018
.nvmrc ⬆️ Update nodejs version on nvmrc Sep 13, 2018
.nycrc Add .nycrc Sep 12, 2017
.prettierignore ♻️ Remove unused files and clean formatting Jul 9, 2018
.prettierrc.json 🌱 Add prettier rc file Dec 14, 2017
.snyk Add snyk test Oct 5, 2017
Jenkinsfile Read coveralls token from Jenkins credentials Sep 25, 2018
Jenkinsfile.nightly Use nvm wrapper in Jenkinsfile.nightly and Jenkinsfile.private also Sep 13, 2018
Jenkinsfile.private Use nvm wrapper in Jenkinsfile.nightly and Jenkinsfile.private also Sep 13, 2018
LICENSE Initial commit May 8, 2017
README.md 📚 Add link to signature and transaction docs Sep 28, 2018
default_config.json ♻️ Fix testing format and delete unused config keys Jul 27, 2018
package-lock.json ♻️ Update lock file Sep 18, 2018
package.json :seelding: Migrate transaction util commands Sep 13, 2018

README.md

Lisk Commander

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

Build Status License: GPL v3 Dependency Status devDependency Status

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. We currently require Node.js versions 8.3 and above. 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 lisk 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

$ lisk COMMAND
running command...
$ lisk (-v|--version|version)
lisk-commander/2.0.0 darwin-x64 node-v8.12.0
$ lisk --help [COMMAND]
A command line interface for Lisk

VERSION
  lisk-commander/2.0.0 darwin-x64 node-v8.12.0

USAGE
  $ lisk [COMMAND]

COMMANDS
  account      Commands relating to Lisk accounts.
  block        Commands relating to Lisk blocks.
  config       Manages Lisk Commander configuration.
  copyright    Displays copyright notice.
  delegate     Commands relating to Lisk delegates.
  help         Displays help.
  message      Commands relating to user messages.
  node         Commands relating to Lisk node.
  passphrase   Commands relating to Lisk passphrases.
  signature    Commands relating to signatures for Lisk transactions from multisignature accounts.
  transaction  Commands relating to Lisk transactions.
  warranty     Displays warranty notice.

Commands

Documentation

Further information can be found on our documentation site:

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

Something else went wrong. What should I do?

  1. Make sure you’re on the network you intend to be on.
  2. Remove the configuration file (config.json) located in your Lisk Commander configuration directory (~/.lisk by default). When you restart Lisk Commander the default configuration will be recreated.
  3. Get in contact on Lisk Chat or Gitter.
  4. 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/.