NodeKit Overview

NodeKit is a command-line tool for running an Algorand node. It installs the Algorand daemon (algod), gets it synced with a Fast-Catchup, and keeps it configured and up to date, so you do not have to assemble those steps yourself.

Run nodekit with no arguments and it opens a terminal user interface (TUI) showing the node’s live state: the latest round, round time, transactions per second, connected peers, whether peer-to-peer (P2P) networking is enabled, the node version and any available upgrade, the network it is on, protocol upgrade voting, and a table of participating accounts with their status, rewards, key expiry and balance.

Who NodeKit Is For

NodeKit is for anyone who wants a working node without learning every step of manual setup: developers who need a local node to build against, and validators taking part in consensus.

Approach	What it is	Best suited to
NodeKit	A single binary that installs, configures, syncs and monitors `algod`, with a built-in TUI.	Getting a node running quickly, and day-to-day operation of a validator or development node.
Manual installation	Installing `algod` from the Algorand packages or source and driving it with `goal`.	Custom or non-standard deployments, and operators who want full control over every configuration value.
FUNC	A third-party service that runs the node behind a local web interface, on Windows, macOS and Linux.	Operators who prefer a browser UI to a terminal, and Windows users.

These are not mutually exclusive. NodeKit manages a standard algod installation, so goal continues to work against the same node.

Supported Platforms

Platform	Support
Linux (x86_64, arm64)	Supported. Installs `algod` via apt or dnf.
macOS (Apple Silicon, Intel)	Supported. Installs `algod` via Homebrew.
Windows	Only through Windows Subsystem for Linux (WSL). The installer refuses to run natively.

Commands

NodeKit provides the following commands.

Command	What it does
`nodekit`	Opens the TUI with live node status and participation accounts.
`nodekit bootstrap`	Installs Algorand, starts the node and runs a Fast-Catchup in one step.
`nodekit install`	Configures the local package manager and installs the Algorand daemon.
`nodekit start`	Starts the Algorand daemon if it is not already running.
`nodekit stop`	Stops the Algorand daemon.
`nodekit catchup`	Manages Fast-Catchup. Subcommands: `start`, `stop`, `debug`.
`nodekit configure`	Adjusts node configuration. Subcommands: `algod`, `service`, `telemetry`.
`nodekit telemetry`	Controls telemetry reporting. Subcommands: `enable nodely`, `disable`, `status`.
`nodekit debug`	Prints diagnostic information about the node and its environment.
`nodekit upgrade`	Upgrades NodeKit itself if the latest release differs from yours, then the Algorand daemon.
`nodekit uninstall`	Removes the Algorand daemon. On macOS, `--force` also deletes the data directory.

Flags

-n/--no-incentives and -v are flags of the root nodekit command. -d is accepted by start, stop, debug, catchup and its subcommands, configure algod, configure telemetry, telemetry status and telemetry enable nodely. It is not accepted by bootstrap, install, upgrade or uninstall.

Flag	What it does
`-d`, `--datadir`	Points NodeKit at a specific node data directory.
`-n`, `--no-incentives`	Registers participation keys without the incentive-eligible fee.
`-v`, `--version`	Prints the NodeKit version.

Notes

nodekit configure algod --hybrid enables P2P hybrid mode. bootstrap does not turn this on. It is a separate step after your node is running. See P2P configuration.

NodeKit command reference Command, subcommand and flag reference, generated from the NodeKit source

Getting Started

Follow the NodeKit Quick Start to install NodeKit and bring up your first Algorand node.