@constellation-network/node-pilot

A new CLI generated with oclif

• Usage
• The TL;DR Version
• Commands

Usage

$ npm install -g @constellation-network/node-pilot
$ cpilot COMMAND
running command...
$ cpilot (--version|-v)
@constellation-network/node-pilot/0.25.1 darwin-arm64 node-v22.15.0
$ cpilot --help [COMMAND]
USAGE
  $ cpilot COMMAND
...

The TL;DR Version

Simply run cpilot with no commands.

$ cpilot

If no command is entered, node-pilot will automatically perform a series of checks to identify the necessary configurations or actions required to bring your validator node online and connect it to the cluster.

Commands

• cpilot clean [LAYER]
• cpilot config
• cpilot config get [NAME]
• cpilot config set NAME VALUE
• cpilot help [COMMAND]
• cpilot info
• cpilot logs LAYER
• cpilot restart [LAYER]
• cpilot shutdown
• cpilot status
• cpilot uninstall

cpilot clean [LAYER]

Remove data and/or logs from a validator node

USAGE
  $ cpilot clean [LAYER] [-d] [-j] [-l]

ARGUMENTS
  LAYER  network layer to clean. e.g. gl0

FLAGS
  -d, --data  remove only data
  -j, --jars  remove only jars
  -l, --logs  remove only logs

DESCRIPTION
  Remove data and/or logs from a validator node

EXAMPLES
  $ cpilot clean

See code: src/commands/clean.ts

cpilot config

Update configuration settings

USAGE
  $ cpilot config

DESCRIPTION
  Update configuration settings

EXAMPLES
  $ cpilot config

See code: src/commands/config.ts

cpilot config get [NAME]

Show all configuration settings or a specific one

USAGE
  $ cpilot config get [NAME]

ARGUMENTS
  NAME  configuration to get

DESCRIPTION
  Show all configuration settings or a specific one

EXAMPLES
  $ cpilot config get

  $ cpilot config get CL_EXTERNAL_IP

  $ cpilot config get gl0:CL_PUBLIC_HTTP_PORT

See code: src/commands/config/get.ts

cpilot config set NAME VALUE

Set a configuration setting

USAGE
  $ cpilot config set NAME VALUE

ARGUMENTS
  NAME   configuration name
  VALUE  the value to set to the configuration

DESCRIPTION
  Set a configuration setting

EXAMPLES
  $ cpilot config set CL_EXTERNAL_IP 127.0.0.1

  $ cpilot config set gl0:CL_PUBLIC_HTTP_PORT 9000

See code: src/commands/config/set.ts

cpilot help [COMMAND]

Display help for cpilot.

USAGE
  $ cpilot help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for cpilot.

See code: @oclif/plugin-help

cpilot info

Display general info about the validator node

USAGE
  $ cpilot info

DESCRIPTION
  Display general info about the validator node

EXAMPLES
  $ cpilot info

See code: src/commands/info.ts

cpilot logs LAYER

view validator node runtime logs

USAGE
  $ cpilot logs LAYER [-a app|hc] [-f] [-n <value>]

ARGUMENTS
  LAYER  network layer to view. e.g. gl0

FLAGS
  -a, --area=<option>       [default: hc] area to view logs for. e.g. "app" or "hc" for health-check
                            <options: app|hc>
  -f, --follow              continuously wait for additional data to be appended
  -n, --numOfLines=<value>  number of lines at the end of the log to display

DESCRIPTION
  view validator node runtime logs

EXAMPLES
  $ cpilot logs

See code: src/commands/logs.ts

cpilot restart [LAYER]

A full shutdown of the validator node, then restart

USAGE
  $ cpilot restart [LAYER] [--autostart] [--update]

ARGUMENTS
  LAYER  network layer to restart. e.g. gl0

FLAGS
  --autostart  restart each running project if it has been stopped
  --update     update each project if a new version is available

DESCRIPTION
  A full shutdown of the validator node, then restart

EXAMPLES
  $ cpilot restart

See code: src/commands/restart.ts

cpilot shutdown

A full shutdown of the validator node

USAGE
  $ cpilot shutdown

DESCRIPTION
  A full shutdown of the validator node

EXAMPLES
  $ cpilot shutdown

See code: src/commands/shutdown.ts

cpilot status

Display node status and configuration settings

USAGE
  $ cpilot status

DESCRIPTION
  Display node status and configuration settings

See code: src/commands/status.ts

cpilot uninstall

Uninstall Node Pilot

USAGE
  $ cpilot uninstall

DESCRIPTION
  Uninstall Node Pilot

EXAMPLES
  $ cpilot uninstall

See code: src/commands/uninstall.ts