Package Exports

zilcli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (zilcli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

zilcli

===========

CLI Wallet for Zilliqa blockchain.

Installation instructions

If you have nodejs > v8.4.0 installed on your system you can install the CLI globally using

$ npm-install -g zilcli

Or you can install the packaged versions for multiple Operating Systems Go to Releases page and select your desired package.

zilcli
Installation instructions
Usage
Commands

Usage

$ npm install -g zilcli
$ zilcli COMMAND
running command...
$ zilcli (-v|--version|version)
zilcli/1.0.1 darwin-x64 node-v9.4.0
$ zilcli --help [COMMAND]
USAGE
  $ zilcli COMMAND
...

Commands

zilcli balance [HASH]
zilcli help [COMMAND]
zilcli tx
zilcli tx:send
zilcli update [CHANNEL]
zilcli wallet
zilcli wallet:create [NAME]
zilcli wallet:details [NAME]
zilcli wallet:export [NAME]
zilcli wallet:import [NAME] [PRIVATEKEY]
zilcli wallet:list
zilcli wallet:remove [NAME]

`zilcli balance [HASH]`

Check balance by address or by Private Key

USAGE
  $ zilcli balance [HASH]

ARGUMENTS
  HASH  Address or Private Key value

OPTIONS
  -b, --by=privateKey|address  [default: address] Type of check: privateKey or address
  -c, --convert=convert        [default: zil] Convert to
  -t, --testnet                Use testnet

DESCRIPTION
  NOTE: --by flag is required. See examples below

EXAMPLES
  $ zilcli balance 23sdg235935dsg9325sd
  $ zilcli balance 23sdg235935dsg9325sd --by=privateKey
  $ zilcli balance 23sdg235935dsg9325sd --by=address --testnet

See code: src/commands/balance.js

`zilcli help [COMMAND]`

display help for zilcli

USAGE
  $ zilcli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`zilcli tx`

Transactions Facade

USAGE
  $ zilcli tx

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/tx/index.js

`zilcli tx:send`

Create and send a transaction

USAGE
  $ zilcli tx:send

OPTIONS
  -a, --amount=amount  amount in ZIL
  -f, --from=from      account name or privateKey
  -g, --gas=gas        gas to use (defined in Li)
  -p, --usePrivateKey  Private Key
  -t, --to=to          destination address

DESCRIPTION

See code: src/commands/tx/send.js

`zilcli update [CHANNEL]`

update the zilcli CLI

USAGE
  $ zilcli update [CHANNEL]

See code: @oclif/plugin-update

`zilcli wallet`

Wallet Facade

USAGE
  $ zilcli wallet

OPTIONS
  --loglevel=error|warn|info|debug

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/wallet/index.js

`zilcli wallet:create [NAME]`

Describe the command here

USAGE
  $ zilcli wallet:create [NAME]

ARGUMENTS
  NAME  Wallet name used across the CLI

OPTIONS
  --loglevel=error|warn|info|debug

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/wallet/create.js

`zilcli wallet:details [NAME]`

Prints out details about Wallet

USAGE
  $ zilcli wallet:details [NAME]

ARGUMENTS
  NAME  Wallet name to get details for

OPTIONS
  --loglevel=error|warn|info|debug

DESCRIPTION
  Returned data: Name, ID, Address, Balance privateKey, publicKey, Network details

See code: src/commands/wallet/details.js

`zilcli wallet:export [NAME]`

Export account to keystore file

USAGE
  $ zilcli wallet:export [NAME]

ARGUMENTS
  NAME  account name you want to export

OPTIONS
  --loglevel=error|warn|info|debug

DESCRIPTION
  Export wallet account to keystore file encoded with passphrase.

See code: src/commands/wallet/export.js

`zilcli wallet:import [NAME] [PRIVATEKEY]`

Import wallet

USAGE
  $ zilcli wallet:import [NAME] [PRIVATEKEY]

ARGUMENTS
  NAME        [default: default] Account name
  PRIVATEKEY  File path / Private Key

OPTIONS
  --type=keystore|privateKey  [default: privateKey] import type

DESCRIPTION
  You can import wallet accounts from keystore file or by Private Key
  Keystore file must be located in $HOME/.zilcli/ directory.

See code: src/commands/wallet/import.js

`zilcli wallet:list`

Lists all configured Zilliqa Wallets

USAGE
  $ zilcli wallet:list

OPTIONS
  --loglevel=error|warn|info|debug

DESCRIPTION
  Prints a table with all the configured Wallet Accounts.
  ID, Name, Address, Balance

See code: src/commands/wallet/list.js

`zilcli wallet:remove [NAME]`

Remove an account from Local Wallet

USAGE
  $ zilcli wallet:remove [NAME]

ARGUMENTS
  NAME  account name you want to remove

OPTIONS
  --loglevel=error|warn|info|debug

See code: src/commands/wallet/remove.js