This documentation will be superseded by the rewritten documentation at docs-beta.theqrl.org.
Or see zond-docs.theqrl.org to try our new cutting edge Proof-of-Stake network with EVM smart contracts.

Head back to Documentation

Documentation

QRL Command Line

QRL CLI

In action

Install
Usage
Commands

Install

Requirements

Requires node and npm to be installed.

Node Install

Install the qrl-cli via npm


npm install -g @theqrl/cli

Build from sources

To build form sources, grab the repo at:

git clone https://github.com/theQRL/qrl-cli.git

cd qrl-cli

npm install

#./bin/run {COMMAND}
./bin/run status

Usage

qrl-cli COMMAND
running command...
qrl-cli (-v|--version|version)
@theqrl/cli/1.3.0 linux-x64 node-v12.3.1

qrl-cli --help [COMMAND]
USAGE
  qrl-cli COMMAND
...

`qrl-cli balance ADDRESS`

Get a wallet balance from the network

USAGE
  $ qrl-cli balance ADDRESS

ARGUMENTS
  ADDRESS  address to return balance for

OPTIONS
  -a, --api=api            api endpoint (for custom QRL network deployments)
  -p, --password=password  wallet file password
  -q, --quanta             reports the balance in Quanta
  -s, --shor               reports the balance in Shor

DESCRIPTION
  ...
  TODO

See code: src/commands/balance.js

`qrl-cli create-wallet`

Create a QRL address

USAGE
  $ qrl-cli create-wallet

OPTIONS
  -1, --sha2256            use SHA2-256 hashing machanism
  -2, --shake128           use SHAKE-128 hashing machanism
  -3, --shake256           use SHAKE-256 hashing machanism
  -f, --file=file          create wallet to json file
  -h, --height=height      tree height (even numbers 4-18)
  -p, --password=password  password for encrypted wallet file

DESCRIPTION
  ...
  TODO

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

`qrl-cli help [COMMAND]`

display help for qrl-cli

USAGE
  $ qrl-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`qrl-cli ots ADDRESS`

Get a address’s OTS state from the network

USAGE
  $ qrl-cli ots ADDRESS

ARGUMENTS
  ADDRESS  address to return OTS state for

OPTIONS
  -g, --grpc=grpc          advanced: grcp endpoint (for devnet/custom QRL network deployments)
  -m, --mainnet            queries mainnet for the OTS state
  -p, --password=password  wallet file password
  -t, --testnet            queries testnet for the OTS state

DESCRIPTION
  ...
  TODO

See code: src/commands/ots.js

`qrl-cli receive ADDRESS`

Displays a QR code of the QRL address to receive a transaction

USAGE
  $ qrl-cli receive ADDRESS

ARGUMENTS
  ADDRESS  address to display QR code for

OPTIONS
  -p, --password=password  wallet file password

DESCRIPTION
  ...
  TODO

See code: src/commands/receive.js

`qrl-cli status`

Gets the network status

USAGE
  $ qrl-cli status

OPTIONS
  -g, --grpc=grpc  advanced: grcp endpoint (for devnet/custom QRL network deployments)
  -m, --mainnet    queries mainnet for the OTS state
  -t, --testnet    queries testnet for the OTS state

DESCRIPTION
  ...
  TODO

See code: src/commands/status.js

`qrl-cli validate ADDRESS`

Validate a QRL address

USAGE
  $ qrl-cli validate ADDRESS

ARGUMENTS
  ADDRESS  address to validate

OPTIONS
  -q, --quiet  quiet mode: no address details, just return validity via exit code

DESCRIPTION
  ...
  when passed a QRL address in hexstring (preceded by 'Q'), will return details about the addresses validity.

See code: src/commands/validate.js

Still stuck? There's help over on Discord!

Zug, Switzerland CHE-229.731.700

info@theqrl.org