2.4. Use

This section explains which commands are available to manage your node.

2.4.1. Quick start

To create a new node, run the command below. A menu will be started that allows you to set up a node configuration file. For more details, check out the Configure section.

v6 node new

To run a node, execute the command below. The --attach flag will cause log output to be printed to the console.

v6 node start --name <your_node> --attach

Finally, a node can be stopped again with:

v6 node stop --name <your_node>

Note

Before the node is started, it is attempted to obtain the server version. For a server of version x.y.z, a node of version x.y.<latest> is started - this is the latest available node version for the server version. If no server version can be obtained, the latest node of the same major version as the command-line interface installation is started.

2.4.2. Available commands

Below is a list of all commands you can run for your node(s). To see all available options per command use the --help flag, i.e. v6 node start --help .

Command

Description

v6 node new

Create a new node configuration file

v6 node start

Start a node

v6 node stop

Stop a node

v6 node restart

Restart a node (stop and start combined)

v6 node files

List the files of a node (e.g. config and log files)

v6 node attach

Print the node logs to the console

v6 node list

List all existing nodes

v6 node create-private-key

Create and upload a new public key for your organization

v6 node set-api-key

Update the API key in your node configuration file

Local test setup

Check the section on Local test setup of the server if you want to run both the node and server on the same machine.