Node CLI
SKALE Node CLI, part of the SKALE suite of validator tools, is the command line to setup, register and maintain your SKALE node.
Installation
Download the executable
VERSION_NUM={put the version number here} && sudo -E bash -c "curl -L https://github.com/skalenetwork/node-cli/releases/download/$VERSION_NUM/skale-$VERSION_NUM-`uname -s`-`uname -m` > /usr/local/bin/skale"
For versions <1.1.0
:
VERSION_NUM=0.0.0 && sudo -E bash -c "curl -L https://skale-cli.sfo2.cdn.digitaloceanspaces.com/skale-$VERSION_NUM-`uname -s`-`uname -m` > /usr/local/bin/skale"
CLI usage
Node commands
Prefix: skale node
Node information
Get base info about SKALE node
skale node info
Options:
-f/--format json/text
- optional
Node initialization
Initialize a SKALE node on current machine
Please avoid re-initialization: First run skale node info to confirm current state of initialization.
|
skale node init [ENV_FILE]
Arguments:
-
ENV_FILE
- path to .env file (required parameters are listed in theskale init
command)
You should specify the following environment variables:
-
SGX_SERVER_URL
- SGX server URL -
DISK_MOUNTPOINT
- disk mount point for storing sChains data -
DOCKER_LVMPY_STREAM
- stream ofdocker-lvmpy
to use -
CONTAINER_CONFIGS_STREAM
- stream ofskale-node
to use -
IMA_ENDPOINT
- IMA endpoint to connect -
ENDPOINT
- RPC endpoint of the node in the network where SKALE Manager is deployed -
MANAGER_CONTRACTS_ABI_URL
- URL to SKALE Manager contracts ABI and addresses -
IMA_CONTRACTS_ABI_URL
- URL to IMA contracts ABI and addresses -
FILEBEAT_URL
- URL to the Filebeat log server
Optional variables:
-
TG_API_KEY
- Telegram API key -
TG_CHAT_ID
- Telegram chat ID -
MONITORING_CONTAINERS
- will enable monitoring containers (filebeat
,cadvisor
,prometheus
)
Node initialization from backup
Restore SKALE node on another machine
skale node restore [BACKUP_PATH] [ENV_FILE]
Arguments:
-
BACKUP_PATH
- path to the archive with backup data generated byskale node backup
command -
ENV_FILE
- path to .env file (required parameters are listed in theskale init
command)
Node backup
Generate backup file to restore SKALE node on another machine
skale node backup [BACKUP_FOLDER_PATH] [ENV_FILE]
Arguments:
-
BACKUP_FOLDER_PATH
- path to the folder where the backup file will be saved
Node Registration
skale node register
Required arguments:
-
--ip
- public IP for RPC connections and consensus -
--domain
/-d
- SKALE node domain name -
--name
- SKALE node name
Optional arguments:
-
--port
- public port - beginning of the port range for node SKALE Chains (default:10000
)
Node update
Update SKALE node on current machine
skale node update [ENV_FILEPATH]
Options:
-
--yes
- remove without additional confirmation
Arguments:
-
ENV_FILEPATH
- path to env file where parameters are defined
You can also specify a file with environment variables which will update parameters in env file used during skale node init.
Node turn-off
Turn-off SKALE node on current machine and optionally set it to the maintenance mode
skale node turn-off
Options:
-
--maintenance-on
- set SKALE node into maintenance mode before turning off -
--yes
- remove without additional confirmation
Node turn-on
Turn on SKALE node on current machine and optionally disable maintenance mode
skale node turn-on [ENV_FILEPATH]
Options:
-
--maintenance-off
- turn off maintenance mode after turning on the node -
--yes
- remove without additional confirmation
Arguments:
-
ENV_FILEPATH
- path to env file where parameters are defined
You can also specify a file with environment variables which will update parameters in env file used during skale node init.
sChain commands
Prefix: skale schains
Health commands
Prefix: skale health
SKALE containers
List all SKALE containers running on the connected node
skale health containers
Options:
-
-a/--all
- list all containers (by default - only running)
sChains healthchecks
Show health check results for all SKALE Chains on the node
skale health schains
Options:
-
--json
- Show data in JSON format
SGX
Status of the SGX server. Returns the SGX server URL and connection status.
$ skale health sgx
SGX server status:
┌────────────────┬────────────────────────────┐
│ SGX server URL │ https://0.0.0.0:1026/ │
├────────────────┼────────────────────────────┤
│ Status │ CONNECTED │
└────────────────┴────────────────────────────┘
SSL commands
Prefix: skale ssl
Logs commands
Prefix: skale logs
Resources allocation commands
Prefix: skale resources-allocation
Generate/update
Generate/update allocation file:
skale resources-allocation generate [ENV_FILE]
Arguments:
-
ENV_FILE
- path to .env file (required parameters are listed in theskale init
command)
Options:
-
--yes
- generate without additional confirmation -
-f/--force
- rewrite allocation file if it exists