Adminstering your node

The Nuts executable this project provides can be used to both run a Nuts server (a.k.a. node) and administer a running node remotely. This chapter explains how to administer your running Nuts node.

Prerequisites

The following is needed to run a Nuts node:

  1. Nuts executable for your platform.

  2. The address of your running Nuts node. You can pass this using the address variable.

Commands

Run the executable without command or flags, or with the help command to find out what commands are supported:

$ nuts

For example, to list all network transactions in your node (replace the value of NUTS_ADDRESS with the HTTP address of your Nuts node):

$ NUTS_ADDRESS=my-node:1323 nuts network list

The following options can be supplied when running CLI commands:

Key

Default

Description

address

localhost:1323

Address of the remote node. Must contain at least host and port, URL scheme may be omitted. In that case it ‘http://’ is prepended.

timeout

10s

Client time-out when performing remote operations, such as ‘500ms’ or ’10s’. Refer to Golang’s ‘time.Duration’ syntax for a more elaborate description of the syntax.