Eosclienttool

Introduction to clio

clio is a command line tool that interfaces with the REST api exposed by nodeop. In order to use clio you will need to have a local copy of nodeop running and configured to load the 'sysio::chain_api_plugin'.

clio contains documentation for all of its commands. For a list of all commands known to clio, simply run it with no arguments:

$ ./clio
Command Line Interface to SYSIO Client
Usage: programs/clio/clio [OPTIONS] SUBCOMMAND
 
Options:
  -h,--help                   Print this help message and exit
  -u,--url TEXT=http://localhost:8888/
                              the http/https URL where nodeop is running
  --wallet-url TEXT=http://localhost:8888/
                              the http/https URL where kiod is running
  -r,--header                 pass specific HTTP header, repeat this option to pass multiple headers
  -n,--no-verify              don't verify peer certificate when using HTTPS
  -v,--verbose                output verbose errors and action output
 
Subcommands:
  version                     Retrieve version information
  create                      Create various items, on and off the blockchain
  get                         Retrieve various items and information from the blockchain
  set                         Set or update blockchain state
  transfer                    Transfer tokens from account to account
  net                         Interact with local p2p network connections
  wallet                      Interact with local wallet
  sign                        Sign a transaction
  push                        Push arbitrary transactions to the blockchain
  multisig                    Multisig contract commands

To get help with any particular subcommand, run it with no arguments as well:

$ ./clio create
Create various items, on and off the blockchain
Usage: ./clio create SUBCOMMAND
 
Subcommands:
  key                         Create a new keypair and print the public and private keys
  account                     Create a new account on the blockchain (assumes system contract does not restrict RAM usage)
 
$ ./clio create account
Create a new account on the blockchain (assumes system contract does not restrict RAM usage)
Usage: ./clio create account [OPTIONS] creator name OwnerKey ActiveKey
 
Positionals:
  creator TEXT                The name of the account creating the new account
  name TEXT                   The name of the new account
  OwnerKey TEXT               The owner public key for the new account
  ActiveKey TEXT              The active public key for the new account
 
Options:
  -x,--expiration             set the time in seconds before a transaction expires, defaults to 30s
  -f,--force-unique           force the transaction to be unique. this will consume extra bandwidth and remove any protections against accidently issuing the same transaction multiple times
  -s,--skip-sign              Specify if unlocked wallet keys should be used to sign transaction
  -d,--dont-broadcast         don't broadcast transaction to the network (just print to stdout)
  -p,--permission TEXT ...    An account and permission level to authorize, as in 'account@permission' (defaults to 'creator@active')