This repository has been archived by the owner on Apr 15, 2019. It is now read-only.
Update readme - Closes #604 #612
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Lisk Commander | ||
|
|
||
| Lisk Commander allows you to communicate with a remote or local node and carry out Lisk-related functionality. | ||
|
|
||
| [](https://jenkins.lisk.io/job/lisk-commander/job/development/) | ||
| [](http://www.gnu.org/licenses/gpl-3.0) | ||
|
|
@@ -9,7 +9,7 @@ Lisk Commander allows you to communicate with a remote or local node and carry o | |
|
|
||
| ## Prerequisites | ||
|
|
||
| Lisk Commander requires [Node.js](https://nodejs.org/) 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](https://nodejs.org/en/download/). We currently require Node.js versions 8.3 and above. NPM is automatically installed along with Node.js. | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
@@ -19,7 +19,7 @@ Lisk Commander requires [Node.js](https://nodejs.org/) as the underlying engine | |
| $ npm install --global --production lisk-commander | ||
| ``` | ||
|
|
||
| Upon successful completion, NPM will add the `lisk-commander` executable `lisk` to your PATH. | ||
|
|
||
| ### From Source | ||
|
|
||
|
|
@@ -39,7 +39,7 @@ 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](https://lisk.io/documentation/lisk-commander/setup)), 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. | ||
|
|
||
|
|
@@ -65,79 +65,68 @@ This will also add `lisk` to your PATH, but you won't have to repeat the process | |
|
|
||
| ## Usage | ||
|
|
||
| <!-- usage --> | ||
|
|
||
| ```sh-session | ||
| $ 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. | ||
| ``` | ||
|
|
||
| <!-- usagestop --> | ||
|
|
||
| ## Commands | ||
|
|
||
| <!-- commands --> | ||
|
|
||
| * [`lisk account`](docs/account.md) - Commands relating to Lisk accounts. | ||
| * [`lisk block`](docs/block.md) - Commands relating to Lisk blocks. | ||
| * [`lisk config`](docs/config.md) - Manages Lisk Commander configuration. | ||
| * [`lisk copyright`](docs/copyright.md) - Displays copyright notice. | ||
| * [`lisk delegate`](docs/delegate.md) - Commands relating to Lisk delegates. | ||
| * [`lisk help`](docs/help.md) - Displays help. | ||
| * [`lisk message`](docs/message.md) - Commands relating to user messages. | ||
| * [`lisk node`](docs/node.md) - Commands relating to Lisk node. | ||
| * [`lisk passphrase`](docs/passphrase.md) - Commands relating to Lisk passphrases. | ||
| * [`lisk signature`](docs/signature.md) - Commands relating to signatures for Lisk transactions from multisignature accounts. | ||
| * [`lisk transaction`](docs/transaction.md) - Commands relating to Lisk transactions. | ||
| * [`lisk warranty`](docs/warranty.md) - Displays warranty notice. | ||
|
|
||
| <!-- commandsstop --> | ||
|
|
||
| ## Documentation | ||
|
|
||
| Further information can be found on our documentation site: | ||
|
|
||
| * [Introduction](https://lisk.io/documentation/lisk-commander) | ||
| * [Setup](https://lisk.io/documentation/lisk-commander/setup) | ||
| * [Upgrade](https://lisk.io/documentation/lisk-commander/upgrade) | ||
| * [User Guide](https://lisk.io/documentation/lisk-commander/user-guide) | ||
| * [Sensitive Inputs](https://lisk.io/documentation/lisk-commander/user-guide/sensitive-inputs) | ||
| * [Commands](https://lisk.io/documentation/lisk-commander/user-guide/commands) | ||
|
|
||
| ## Get Involved | ||
|
|
||
|
|
@@ -155,27 +144,10 @@ $ npm test | |
|
|
||
| ## FAQ | ||
|
|
||
| ### Something else went wrong. What should I do? | ||
|
|
||
| 1. Make sure you’re on the network you intend to be on. | ||
| 1. 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. | ||
|
There was a problem hiding this comment. Path to configuration should be There was a problem hiding this comment. this was actually correct, on |
||
| 1. Get in contact on [Lisk Chat][] or [Gitter][]. | ||
| 1. If it seems like a bug, open an issue on [GitHub][bugs]. See the [Contribution Guidelines]. | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # `lisk account` | ||
|
|
||
| Commands relating to Lisk accounts. | ||
|
|
||
| * [`lisk account:create`](#lisk-account-create) | ||
| * [`lisk account:get ADDRESSES`](#lisk-account-get-addresses) | ||
| * [`lisk account:show`](#lisk-account-show) | ||
|
|
||
| ## `lisk account:create` | ||
|
|
||
| Returns a randomly-generated mnemonic passphrase with its corresponding public/private key pair and Lisk address. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ lisk account:create | ||
|
|
||
| OPTIONS | ||
| -j, --[no-]json Prints output in JSON format. You can change the default behaviour in your config.json file. | ||
|
|
||
| --[no-]pretty Prints JSON in pretty format rather than condensed. Has no effect if the output is set to table. You | ||
| can change the default behaviour in your config.json file. | ||
|
|
||
| DESCRIPTION | ||
| Returns a randomly-generated mnemonic passphrase with its corresponding public/private key pair and Lisk address. | ||
|
|
||
| EXAMPLE | ||
| account:create | ||
| ``` | ||
|
|
||
| ## `lisk account:get ADDRESSES` | ||
|
|
||
| Gets account information from the blockchain. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ lisk account:get ADDRESSES | ||
|
|
||
| ARGUMENTS | ||
| ADDRESSES Comma-separated address(es) to get information about. | ||
|
|
||
| OPTIONS | ||
| -j, --[no-]json Prints output in JSON format. You can change the default behaviour in your config.json file. | ||
|
|
||
| --[no-]pretty Prints JSON in pretty format rather than condensed. Has no effect if the output is set to table. You | ||
| can change the default behaviour in your config.json file. | ||
|
|
||
| DESCRIPTION | ||
| Gets account information from the blockchain. | ||
|
|
||
| EXAMPLES | ||
| account:get 3520445367460290306L | ||
| account:get 3520445367460290306L,2802325248134221536L | ||
| ``` | ||
|
|
||
| ## `lisk account:show` | ||
|
|
||
| Shows account information for a given passphrase. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ lisk account:show | ||
|
|
||
| OPTIONS | ||
| -j, --[no-]json | ||
| Prints output in JSON format. You can change the default behaviour in your config.json file. | ||
|
|
||
| -p, --passphrase=passphrase | ||
| Specifies a source for your secret passphrase. Lisk Commander will prompt you for input if this option is not set. | ||
| Source must be one of `prompt`, `pass`, `env`, `file` or `stdin`. For `pass`, `env` and `file` a corresponding | ||
| identifier must also be provided. | ||
| Examples: | ||
| - --passphrase=prompt (default behaviour) | ||
| - --passphrase='pass:my secret passphrase' (should only be used where security is not important) | ||
| - --passphrase=env:SECRET_PASSPHRASE | ||
| - --passphrase=file:/path/to/my/passphrase.txt (takes the first line only) | ||
| - --passphrase=stdin (takes one line only) | ||
|
|
||
| --[no-]pretty | ||
| Prints JSON in pretty format rather than condensed. Has no effect if the output is set to table. You can change the | ||
| default behaviour in your config.json file. | ||
|
|
||
| DESCRIPTION | ||
| Shows account information for a given passphrase. | ||
|
|
||
| EXAMPLE | ||
| account:show | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # `lisk block` | ||
|
|
||
| Commands relating to Lisk blocks. | ||
|
|
||
| * [`lisk block:get BLOCKIDS`](#lisk-block-get-blockids) | ||
|
|
||
| ## `lisk block:get BLOCKIDS` | ||
|
|
||
| Gets block information from the blockchain. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ lisk block:get BLOCKIDS | ||
|
|
||
| ARGUMENTS | ||
| BLOCKIDS Comma-separated block ID(s) to get information about. | ||
|
|
||
| OPTIONS | ||
| -j, --[no-]json Prints output in JSON format. You can change the default behaviour in your config.json file. | ||
|
|
||
| --[no-]pretty Prints JSON in pretty format rather than condensed. Has no effect if the output is set to table. You | ||
| can change the default behaviour in your config.json file. | ||
|
|
||
| DESCRIPTION | ||
| Gets block information from the blockchain. | ||
|
|
||
| EXAMPLES | ||
| block:get 17108498772892203620 | ||
| block:get 17108498772892203620,8541428004955961162 | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # `lisk config` | ||
|
|
||
| Manages Lisk Commander configuration. | ||
|
|
||
| * [`lisk config:set VARIABLE [VALUES]`](#lisk-config-set-variable-values) | ||
| * [`lisk config:show`](#lisk-config-show) | ||
|
|
||
| ## `lisk config:set VARIABLE [VALUES]` | ||
|
|
||
| Sets configuration. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ lisk config:set VARIABLE [VALUES] | ||
|
|
||
| OPTIONS | ||
| -j, --[no-]json Prints output in JSON format. You can change the default behaviour in your config.json file. | ||
|
|
||
| --[no-]pretty Prints JSON in pretty format rather than condensed. Has no effect if the output is set to table. You | ||
| can change the default behaviour in your config.json file. | ||
|
|
||
| DESCRIPTION | ||
| Sets configuration. | ||
| ... | ||
| Variables available: api.nodes, api.network, json, pretty. | ||
|
|
||
| EXAMPLES | ||
| config:set json true | ||
| config:set api.network main | ||
| config:set api.nodes https://127.0.0.1:4000,http://mynode.com:7000 | ||
| ``` | ||
|
|
||
| ## `lisk config:show` | ||
|
|
||
| Prints the current configuration. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ lisk config:show | ||
|
|
||
| OPTIONS | ||
| -j, --[no-]json Prints output in JSON format. You can change the default behaviour in your config.json file. | ||
|
|
||
| --[no-]pretty Prints JSON in pretty format rather than condensed. Has no effect if the output is set to table. You | ||
| can change the default behaviour in your config.json file. | ||
|
|
||
| DESCRIPTION | ||
| Prints the current configuration. | ||
|
|
||
| EXAMPLE | ||
| config:show | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # `lisk copyright` | ||
|
|
||
| Displays copyright notice. | ||
|
|
||
| * [`lisk copyright`](#lisk-copyright) | ||
|
|
||
| ## `lisk copyright` | ||
|
|
||
| Displays copyright notice. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ lisk copyright | ||
|
|
||
| OPTIONS | ||
| -j, --[no-]json Prints output in JSON format. You can change the default behaviour in your config.json file. | ||
|
|
||
| --[no-]pretty Prints JSON in pretty format rather than condensed. Has no effect if the output is set to table. You | ||
| can change the default behaviour in your config.json file. | ||
|
|
||
| DESCRIPTION | ||
| Displays copyright notice. | ||
|
|
||
| EXAMPLE | ||
| copyright | ||
| ``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"8.3 and above" or "8.3 (inclusive)"?