Humanode Docs
Search…
⌃K

CLI

This section provides information on the node's command-line interface.

What is CLI

CLI stands for Command Line Interface.
humanode-peer is a command line application, and it exposes a CLI as all the other console commands do.

General CLI layout

humanode-peer is an executable with multiple subcommands. If no subcommands are specified, it will run as a Humanode blockchain node (we call it "run command"). If a subcommand is specified, the relevant subcommand will be executed.
To learn about the available subcommands, flags and options use the --help flag:
$ humanode-peer --help
Humanode is built on top of the Substrate framework, and we reuse most of the CLI from the standard Substrate layout.
Please refer to the Substrate documentation to learn more about the standard Substrate CLI:

Usage

You would typically run your blockchain node with the following arguments.
$ humanode-peer --chain your-chainspec.json
For development, it is nice to use --dev flag:
$ humanode-peer --dev

Run command

We have a few flags that we've added on top of the standard Substrate CLI for the run command.
For the rest of the flags, please see the Substrate documentation as referred in the General CLI layout section.

Bioauth flags and options

There is a list of bioauth-related options and flags.
Bioauth options
Description
--robonode-url <ROBONODE_URL>
The URL of robonode to authenticate with. Optional, typically set in chainspec so you don't have to pass it manually.
--webapp-url <WEBAPP_URL>
The URL to use for the web app. Used to print the QR Code to the console. Optional, typically set in chainspec so you don't have to pass it manually.
--rpc-url <RPC_URL>
The URL to pass to the web app to connect to the node RPC.
If not passed, a URL with localhost and the WebSocket RPC port will be used. Mutually exclusive with other options setting the RPC URL.
--rpc-url-ngrok-detect
Detect RPC URL from ngrok. This will also work with Humanode WebSocket Tunnel.
--rpc-url-ngrok-detect-from <TUNNEL_NAME>
The tunnel name at ngrok to detect RPC URL from, if ngrok is used to detect the RPC URL. [default: command_line]
--rpc-url-scheme-preference <RPC_URL_SCHEME_PREFERENCE>
What RPC URL port to prefer. [default: no-preference] [possible values: http, ws, no-preference]
--rpc-url-unset
Explicitly unset the RPC URL. Might be useful if you want to do something exotic, but generally, you'd want the RPC URL set.