symbol-peertools

Symbol Peer Node Tools

• Usage
• Commands

Usage

$ npm install -g symbol-peertools
$ symbol-peertools COMMAND
running command...
$ symbol-peertools (--version)
symbol-peertools/1.0.5 win32-x64 node-v20.16.0
$ symbol-peertools --help [COMMAND]
USAGE
  $ symbol-peertools COMMAND
...

Commands

• symbol-peertools certGen
• symbol-peertools certInfo
• symbol-peertools certRenew
• symbol-peertools chainInfo
• symbol-peertools help [COMMAND]
• symbol-peertools nodeDiagnosticCounters
• symbol-peertools nodeInfo
• symbol-peertools nodePeers
• symbol-peertools nodeTime
• symbol-peertools nodeUnlockedAccount
• symbol-peertools rest CMD
• symbol-peertools watcher CMD
• symbol-peertools wizard

symbol-peertools certGen

Generate Symbol node certificate.

USAGE
  $ symbol-peertools certGen [--cadays <value>] [--caname <value>] [--certdir <value>] [--force] [--nodedays
    <value>] [--nodename <value>] [--privatekeys <value>]

FLAGS
  --cadays=<value>       [default: 7300] CA certificate days
  --caname=<value>       [default: Simple Symbol CA] CA Name
  --certdir=<value>      [default: ./cert] Certificate output directory
  --force                Overwrite certificate output directory
  --nodedays=<value>     [default: 375] Node certificate days
  --nodename=<value>     [default: Simple Symbol Node] Node Name
  --privatekeys=<value>  [default: ./privatekeys.yaml] Encrypted privatekeys file save path

DESCRIPTION
  Generate Symbol node certificate.

EXAMPLES
  $ symbol-peertools certGen --caname "Test CA" --nodename "Test Node"

See code: src/commands/certGen/index.ts

symbol-peertools certInfo

Display Symbol node certificate information.

USAGE
  $ symbol-peertools certInfo [--certdir <value>] [-n <value>]

FLAGS
  -n, --networkId=<value>  [default: mainnet] network ID(mainnet/testnet/any number)
      --certdir=<value>    [default: ./cert] Certificate directory

DESCRIPTION
  Display Symbol node certificate information.

EXAMPLES
  $ symbol-peertools certInfo

See code: src/commands/certInfo/index.ts

symbol-peertools certRenew

Renew Symbol node certificate.

USAGE
  $ symbol-peertools certRenew [--cadays <value>] [--certdir <value>] [--nodedays <value>] [--privatekeys
    <value>]

FLAGS
  --cadays=<value>       [default: 7300] CA certificate days
  --certdir=<value>      [default: ./cert] Certificate directory
  --nodedays=<value>     [default: 375] Node certificate days
  --privatekeys=<value>  [default: ./privatekeys.yaml] Encrypted privatekeys file save path

DESCRIPTION
  Renew Symbol node certificate.

EXAMPLES
  $ symbol-peertools certRenew

See code: src/commands/certRenew/index.ts

symbol-peertools chainInfo

Display the same results as /chain/info for API nodes.

USAGE
  $ symbol-peertools chainInfo [-p <value>] [-h <value>] [-c <value>]

FLAGS
  -c, --configFilePath=<value>  [default: ./config.json] Config file path.
  -h, --host=<value>            [default: 127.0.0.1] Host of Symbol node to access.
  -p, --port=<value>            [default: 7900] Port of symbol node to be accessed.

DESCRIPTION
  Display the same results as /chain/info for API nodes.

EXAMPLES
  $ symbol-peertools chainInfo

See code: src/commands/chainInfo/index.ts

symbol-peertools help [COMMAND]

Display help for symbol-peertools.

USAGE
  $ symbol-peertools 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 symbol-peertools.

See code: @oclif/plugin-help

symbol-peertools nodeDiagnosticCounters

Display diagnostic counters for the Symbol node.(IP required for trustedHosts)

USAGE
  $ symbol-peertools nodeDiagnosticCounters [-p <value>] [-h <value>] [-c <value>]

FLAGS
  -c, --configFilePath=<value>  [default: ./config.json] Config file path.
  -h, --host=<value>            [default: 127.0.0.1] Host of Symbol node to access.
  -p, --port=<value>            [default: 7900] Port of symbol node to be accessed.

DESCRIPTION
  Display diagnostic counters for the Symbol node.(IP required for trustedHosts)

EXAMPLES
  $ symbol-peertools nodeDiagnosticCounters

See code: src/commands/nodeDiagnosticCounters/index.ts

symbol-peertools nodeInfo

Display the same results as /node/info for API nodes.

USAGE
  $ symbol-peertools nodeInfo [-p <value>] [-h <value>] [-c <value>]

FLAGS
  -c, --configFilePath=<value>  [default: ./config.json] Config file path.
  -h, --host=<value>            [default: 127.0.0.1] Host of Symbol node to access.
  -p, --port=<value>            [default: 7900] Port of symbol node to be accessed.

DESCRIPTION
  Display the same results as /node/info for API nodes.

EXAMPLES
  $ symbol-peertools nodeInfo

See code: src/commands/nodeInfo/index.ts

symbol-peertools nodePeers

Display the same results as /node/peers for API nodes.

USAGE
  $ symbol-peertools nodePeers [-p <value>] [-h <value>] [-c <value>]

FLAGS
  -c, --configFilePath=<value>  [default: ./config.json] Config file path.
  -h, --host=<value>            [default: 127.0.0.1] Host of Symbol node to access.
  -p, --port=<value>            [default: 7900] Port of symbol node to be accessed.

DESCRIPTION
  Display the same results as /node/peers for API nodes.

EXAMPLES
  $ symbol-peertools nodePeers

See code: src/commands/nodePeers/index.ts

symbol-peertools nodeTime

Display the same results as /node/time for API nodes.

USAGE
  $ symbol-peertools nodeTime [-p <value>] [-h <value>] [-c <value>]

FLAGS
  -c, --configFilePath=<value>  [default: ./config.json] Config file path.
  -h, --host=<value>            [default: 127.0.0.1] Host of Symbol node to access.
  -p, --port=<value>            [default: 7900] Port of symbol node to be accessed.

DESCRIPTION
  Display the same results as /node/time for API nodes.

EXAMPLES
  $ symbol-peertools nodeTime

See code: src/commands/nodeTime/index.ts

symbol-peertools nodeUnlockedAccount

Display the same results as /node/unlockedaccount for API nodes.(IP required for trustedHosts)

USAGE
  $ symbol-peertools nodeUnlockedAccount [-p <value>] [-h <value>] [-c <value>]

FLAGS
  -c, --configFilePath=<value>  [default: ./config.json] Config file path.
  -h, --host=<value>            [default: 127.0.0.1] Host of Symbol node to access.
  -p, --port=<value>            [default: 7900] Port of symbol node to be accessed.

DESCRIPTION
  Display the same results as /node/unlockedaccount for API nodes.(IP required for trustedHosts)

EXAMPLES
  $ symbol-peertools nodeUnlockedAccount

See code: src/commands/nodeUnlockedAccount/index.ts

symbol-peertools rest CMD

REST for peer node.

USAGE
  $ symbol-peertools rest CMD [-c <value>]

ARGUMENTS
  CMD  REST Server Start or Stop

FLAGS
  -c, --config=<value>  [default: ./config.json] config file.

DESCRIPTION
  REST for peer node.

EXAMPLES
  $ symbol-peertools rest start

  $ symbol-peertools rest start -c ./symbol-peertools/config.json

  $ symbol-peertools rest stop

See code: src/commands/rest/index.ts

symbol-peertools watcher CMD

Monitor Symbol node activity.

USAGE
  $ symbol-peertools watcher CMD [-c <value>]

ARGUMENTS
  CMD  Monitor Symbol node activity Start or Stop.

FLAGS
  -c, --config=<value>  [default: ./config.json] config file.

DESCRIPTION
  Monitor Symbol node activity.

EXAMPLES
  $ symbol-peertools watcher start

  $ symbol-peertools watcher stop

See code: src/commands/watcher/index.ts

symbol-peertools wizard

Wizard for generating Symbol certificate.

USAGE
  $ symbol-peertools wizard [-c <value>]

FLAGS
  -c, --configFilePath=<value>  [default: ./config.json] Config file path.

DESCRIPTION
  Wizard for generating Symbol certificate.

EXAMPLES
  $ symbol-peertools wizard wizard

See code: src/commands/wizard/index.ts