.. _use-node:

Use
----

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

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 :ref:`configure-node` 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 HQ version.
   If HQ has version ``x.y.z``, a node of version ``x.y.<latest>`` is
   started - this is the latest available node version for the HQ version.
   If no HQ version can be obtained, the latest node of the same major
   version as the command-line interface installation is started.

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,
e.g. ``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 and upload a new public key for your    |
| create-private-key``| organization                                   |
+---------------------+------------------------------------------------+
| ``v6 node           | Update the API key in your node configuration  |
| set-api-key``       | file                                           |
+---------------------+------------------------------------------------+

Local test setup
""""""""""""""""

Check out :ref:`this section <local-test>` if you want to run an entire test network
locally.