NodeKit Overview

NodeKit is a terminal-based user interface (TUI) designed to simplify the process of managing Algorand nodes, a one-stop shop for managing Algorand nodes. With NodeKit, you can easily handle tasks like node installation, configuration, and maintenance, all from the command line, making it accessible for beginners and seasoned developers.

Benefits

Setting up and running an Algorand node can be a complex process. NodeKit addresses common challenges by providing a unified interface to:

• Install and bootstrap nodes with minimal configuration.
• Simplify node upgrades and maintenance tasks.
• Manage node settings and debugging in a consistent and structured way.

With NodeKit, you save time and avoid the pitfalls of manual node management, empowering you to focus on building and deploying your applications.

Features

NodeKit offers several powerful features for managing your Algorand nodes:

install

Configures the local package manager and installs the Algorand daemon on your local machine.

nodekit install [flags]

Options:

  -f, --force   forcefully install the node
  -h, --help    help for install

nodekit install Install the node daemon

bootstrap

Get up and running with a fresh Algorand node. Uses the local package manager to install Algorand, then starts the node and performs a Fast-Catchup.

nodekit bootstrap [flags]

Options:

-h, --help   help for bootstrap

nodekit bootstrap Initialize a fresh node

catchup

The entire process should sync a node in minutes rather than hours or days. Actual sync times may vary depending on the number of accounts, number of blocks and the network.

nodekit catchup [flags]

Options:

-d, --datadir string   Data directory for the node
-h, --help             help for catchup

nodekit catchup Manage Fast-Catchup for your node

start

Start the Algorand daemon on your local machine if it is not already running. Optionally, the daemon can be forcefully started.

nodekit start [flags]

Options:

-f, --force   forcefully start the node
-h, --help    help for start

nodekit start Start the node daemon

stop

Stops the Algorand daemon on your local machine. Optionally, the daemon can be forcefully stopped.

This requires the daemon to be installed on your system.

nodekit stop [flags]

Options:

-f, --force   forcefully stop the node
-h, --help    help for stop

nodekit stop Stop the node daemon

Getting started

Ready to get started? Follow the Getting Started Guide to install NodeKit and set up your first Algorand node.