User guide
This guide details important information on how to use and configure Lisk Commander.
Usage
For a full list of all commands and their available options, check the Command reference |
Pass arguments and options directly from the command line, for example:
$ lisk (-v|--version|version) # returns current version of Lisk Commander.
$ lisk [COMMAND]:[ACTION] # to run a command. Available actions depend on the command.
$ lisk [COMMAND] # displays help for a specific command.
$ lisk # displays general help and the command list.
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.
See concrete examples on the Commands page.
Configuration
Show Lisk Commander Config:
lisk config:show
{
"json": true, (1)
"api": {
"nodes": [], (2)
"network": "main" (3)
},
"pretty": false (4)
}
1 | Provide output as json if set to true, otherwise output is table. |
2 | Specify nodes to send requests. |
3 | Specify a default network. It can be "main", "test", "beta" or a custom nethash. |
4 | Pretty print JSON output if set to true. |
Configure the network
lisk config:set api.network <NETWORK>
Possible values for <NETWORK>
are, test
for Testnet, main
for Mainnet, alpha
for Alphanet and beta
for Betanet.
If you did not specify specific nodes for Lisk Commander, it will connect to the pre-defined public nodes of the Lisk Mainnet or Testnet. |
Configure specific nodes
Specify the node Lisk Commander shall communicate with.
If you specify more than one node, it will use the first node as default, and the other nodes as a fallback, if the first node does not respond.
lisk config:set api.nodes https://127.0.0.1:4000,http://mynode.com:7000
See more examples with the config
command on the Commands page.
How to use a custom config file
The configuration file config.json
is located in lisk-sdk/commander/src/config.json
.
If you would prefer to store it elsewhere, run Lisk Commander with the environmental variable LISK_COMMANDER_CONFIG_DIR
set to the path of your choice.
Override config options
Some elements of this configuration can be overridden while executing a command, by using the following options:
Setting | Option |
---|---|
Use JSON output |
|
Use table output |
|
Pretty print JSON |
|
Do not pretty print JSON |
|
See concrete examples on the Commands page.