Orakl Network CLI

Take Control Of The Orakl Network With CLI

The Orakl Network CLI is a tool to configure and manage the Orakl Network. The Orakl Network CLI enables access and modifications of the state of the Orakl Network, therefore it is very important tool for node operator. The code is located under cli directory. The configurable parts of the Orakl Network are listed below:

Installation

We recommend to install the Orakl Network CLI globally using the command below.

npx @bisonai/orakl-cli

After a successful installation, you can start using it with the same command npx @bisonai/orakl-cli. To list all of supported features, you can use the --help flag.

npx @bisonai/orakl-cli --help

The output of the --help command is displayed below.

operator <subcommand>

where <subcommand> can be one of:

- chain
- service
- listener
- vrf
- fetcher
- reporter
- version
- delegator
- proxy

For more help, try running `operator <subcommand> --help`

Setup Alias

The Orakl Network CLI is a tool that node operators will use quite frequently. It might feel clumsy to keep rewriting the @bisonai/ prefix at every command. To combat that we recommend to create an orakl-cli alias for the @bisonai/orakl-cli package. The alias can be defined in your shell configuration file (e.g. .zshrc or .bashrc).

echo "alias orakl-cli='npx @bisonai/orakl-cli'" >> ~/.zshrc

Do not forget to restart your shell after the configuration file update!

Configuration

The Orakl Network CLI needs to communicate with several services of the Orakl Network in order to perform correctly. The state of the Orakl Network is controlled through the Orakl Network API.

To fully configure the Orakl Network CLI, setup the following environment variables.

  • ORAKL_NETWORK_API_URL

  • ORAKL_NETWORK_DELEGATOR_URL

  • LISTENER_SERVICE_HOST

  • LISTENER_SERVICE_PORT

  • WORKER_SERVICE_HOST

  • WORKER_SERVICE_PORT

  • REPORTER_SERVICE_HOST

  • REPORTER_SERVICE_PORT

ORAKL_NETWORK_API_URL and ORAKL_NETWORK_DELEGATOR_URL environment variables represent URLs for communication with the Orakl Network API and Orakl Network Delegator, respectively.

The Orakl Network CLI is able to communicate with a specific listener, worker and reporter through Orakl Network Watchman. To enable this feature, the Orakl Network CLI has to setup environment variables for each service as shown below.

  • Listener (LISTENER_SERVICE_HOST, LISTENER_SERVICE_PORT)

  • Worker (WORKER_SERVICE_HOST, WORKER_SERVICE_PORT)

  • Reporter (REPORTER_SERVICE_HOST, REPORTER_SERVICE_PORT)

PreviousOrakl Network APINextChain

Last updated