Installation
There are multiple ways to install starknode-kit. Choose the method that best suits your needs.
Option 1: Install Script (Recommended)
The easiest and recommended way to install starknode-kit:
/bin/bash -c "$(curl -sSL https://raw.githubusercontent.com/thebuidl-grid/starknode-kit/main/install.sh)"
Or download the script first and then run it:
wget https://raw.githubusercontent.com/thebuidl-grid/starknode-kit/main/install.sh chmod +x install.sh ./install.sh
Option 2: Install using Go
If you have Go installed (version 1.24 or later), you can install starknode-kit directly:
go install -ldflags="-X 'github.com/thebuidl-grid/starknode-kit/pkg/versions.StarkNodeVersion=main'" github.com/thebuidl-grid/starknode-kit@latest
This installs the latest version from the main branch.
Option 3: Manual Installation from Source
1. Clone the Repository
git clone https://github.com/thebuidl-grid/starknode-kit.git cd starknode-kit
2. Build and Install
make build sudo mv bin/starknode /usr/local/bin/
Verify Installation
After installation, verify that starknode-kit is working correctly:
starknode-kit --help
You should see output similar to:
starknode-kit is a CLI tool designed to simplify the setup and management of Ethereum and Starknet nodes. It helps developers quickly configure, launch, monitor, and maintain full nodes or validator setups for both networks. Usage: starknode [command] Available Commands: add Add an Ethereum or Starknet client to the config completion Generate the autocompletion script for the specified shell config Create, show, and update your Starknet node configuration. help Help about any command monitor Launch real-time monitoring dashboard remove Remove a specified resource run Run a specific local infrastructure service start Run the configured Ethereum clients status Display status of running clients stop Stop the configured Ethereum clients update Check for and install client updates validator Manage the Starknet validator client version Show version of starknode-kit or a specific client Flags: -h, --help help for starknode Use "starknode [command] --help" for more information about a command.
Initial Setup
After successful installation, generate your configuration file:
starknode-kit config new
This creates a configuration file at ~/.starknode-kit/starknode.yml.
Uninstallation
To uninstall starknode-kit, remove the binary and configuration directory:
sudo rm /usr/local/bin/starknode-kit rm -rf ~/.config/starknode-kit
⚠️ Note
This will not remove any client data (e.g., blockchain data). The data is stored in the locations specified in your ~/.starknode-kit/starknode.yml file.
Troubleshooting
Command not found
If you get a "command not found" error, make sure /usr/local/bin is in your PATH:
export PATH=$PATH:/usr/local/bin
Add this to your ~/.bashrc or ~/.zshrc to make it permanent.
Permission denied
If you encounter permission issues during installation, make sure you have sudo access or contact your system administrator.