📚 Update readme for 2.0

LiskArchive · Sep 12, 2018 · ad3e7b1 · ad3e7b1
1 parent c8391e8
commit ad3e7b1
Show file tree

Hide file tree

Showing 11 changed files with 685 additions and 83 deletions.
diff --git a/README.md b/README.md
@@ -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 between 6.12 and 6.14 (inclusive). NPM is automatically installed along with Node.js.
+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 above 8.3. 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 to your PATH.
+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](docs:lisk-commander-installation-npm)), following the instructions in this section is not recommended as they will introduce conflicts.
+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,66 @@ This will also add `lisk` to your PATH, but you won't have to repeat the process
 
 ## Usage
 
-### Interactive use
-
-To run commands interactively:
-
-```sh
-$ 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>
+<!-- usage -->
+
+```sh-session
+$ lisk COMMAND
+running command...
+$ lisk (-v|--version|version)
+lisk-commander/2.0.0 darwin-x64 node-v8.11.3
+$ lisk --help [COMMAND]
+A command line interface for Lisk
+
+VERSION
+  lisk-commander/2.0.0 darwin-x64 node-v10.6.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.
 ```
 
-### Non-interactive use
+<!-- usagestop -->
 
-To run commands and options directly from the command line:
+## Commands
 
-```sh
-$ lisk get delegate lightcurve --json
-```
-
-## Settings
+<!-- commands -->
 
-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):
+* [`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 warranty`](docs/warranty.md) - Displays warranty notice.
 
-| Command                                                                    | Description                                                 |
-| -------------------------------------------------------------------------- | ----------------------------------------------------------- |
-| <code>set name lisk</code>                                                 | Sets name to be displayed.                                  |
-| <code>set delimiter lisk</code>                                            | Sets delimiter in interactive mode.                         |
-| <code>set json true&#124;false</code>                                      | Sets default to JSON output (true) or text output (false).  |
-| <code>set pretty true&#124;false</code>                                    | Sets default to formatted output when JSON output is used.  |
-| <code>set api.network main&#124;test&#124;beta</code>                      | Sets API target to the specified network.                   |
-| <code>set api.nodes http://localhost:4000 http://192.168.178.1:4001</code> | Override api.network and set specific nodes communicate to. |
+<!-- commandsstop -->
 
 ## Documentation
 
 Further information can be found on our documentation site:
 
-* [Introduction](https://docs.lisk.io/v1.3/docs/lisk-commander-introduction)
-* [Pre-Installation](https://docs.lisk.io/v1.3/docs/lisk-commander-pre-installation)
-* [Installation](https://docs.lisk.io/v1.3/docs/lisk-commander-installation)
-  * [Install-from-NPM](https://docs.lisk.io/v1.3/docs/lisk-commander-installation-npm)
-  * [Install-from-Source](https://docs.lisk.io/v1.3/docs/lisk-commander-installation-source)
-* [Upgrading](https://docs.lisk.io/v1.3/docs/lisk-commander-upgrading)
-  * [Upgrading-from-NPM](https://docs.lisk.io/v1.3/docs/lisk-commander-upgrading-npm)
-  * [Upgrading-from-Source](https://docs.lisk.io/v1.3/docs/lisk-commander-upgrading-source)
-* [Usage](https://docs.lisk.io/v1.3/docs/lisk-commander-usage)
-  * [Configuration](https://docs.lisk.io/v1.3/docs/lisk-commander-usage-configuration)
-  * [Usage](https://docs.lisk.io/v1.3/docs/lisk-commander-usage-interactive-and-noninteractive)
-  * [Commands](https://docs.lisk.io/v1.3/docs/lisk-commander-usage-commands)
+* [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 +142,10 @@ $ 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.
-1. Exit Lisk Commander (if in interactive mode) and restart.
-1. 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.
+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.
 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].
 

diff --git a/docs/account.md b/docs/account.md
@@ -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
+```
diff --git a/docs/block.md b/docs/block.md
@@ -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
+```
diff --git a/docs/config.md b/docs/config.md
@@ -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
+```
diff --git a/docs/copyright.md b/docs/copyright.md
@@ -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
+```