Contribute via CLI

Testnet III is now live. This is the current testing environment for Nexus Layer 1, focusing on security, decentralization, and orchestration testing.

Introduction

The Nexus Network CLI is a command-line tool for contributing compute resources to the network.

CLI nodes connecting to Nexus

Install Script

Use our installation script:

curl https://cli.nexus.xyz/ | sh

Restart or refresh your terminal (‘source ~/.bashrc, ‘source ~/.zshrc’, etc.). To start with an existing node ID, run:

nexus-network start --node-id <your-node-id>

Alternatively, you can register your wallet address and create a node ID with the CLI, or at at app.nexus.xyz.

nexus-network register-user --wallet-address <your-wallet-address>
nexus-network register-node
nexus-network start

The register-user and register-node commands will save your credentials to ~/.nexus/credentials.json. To clear credentials, run:

nexus-network logout

Use our installation script:

curl https://cli.nexus.xyz/ | sh

Restart or refresh your terminal (‘source ~/.bashrc, ‘source ~/.zshrc’, etc.). To start with an existing node ID, run:

nexus-network start --node-id <your-node-id>

Alternatively, you can register your wallet address and create a node ID with the CLI, or at at app.nexus.xyz.

nexus-network register-user --wallet-address <your-wallet-address>
nexus-network register-node
nexus-network start

The register-user and register-node commands will save your credentials to ~/.nexus/credentials.json. To clear credentials, run:

nexus-network logout

System Requirements

  sudo apt update
  sudo apt upgrade
  sudo apt install build-essential pkg-config libssl-dev git-all
  sudo apt install protobuf-compiler

  # Install Rust (if not already installed)
  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  git clone git@github.com:nexus-xyz/nexus-cli.git
  cd clients/cli
  cargo build --release

  sudo apt update
  sudo apt upgrade
  sudo apt install build-essential pkg-config libssl-dev git-all
  sudo apt install protobuf-compiler

  # Install Rust (if not already installed)
  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  git clone git@github.com:nexus-xyz/nexus-cli.git
  cd clients/cli
  cargo build --release

# Install using Homebrew
brew install protobuf

# Verify installation
protoc --version

# Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
git clone git@github.com:nexus-xyz/nexus-cli.git
cd clients/cli
cargo build --release

Install WSL

Install WSL (Windows Subsystem for Linux)

Follow Linux Instructions

Once WSL is installed, follow the Linux instructions above

Setup & Configuration

Initial Setup

Run the CLI for the first time.
Accept the Terms of Use.
Choose between anonymous or linked proving (see below).

Choose Proving Mode

You have two options:

Create an account at app.nexus.xyz.
Follow the account linking instructions.
Your contributions will earn NEX Points.
Track your progress on the leaderboard.
Manage all your nodes in one place.

To earn NEX Points, you must link your CLI to your Nexus account. Anonymous proving will not record contributions.

Troubleshooting

If you have previously proved with an older version of the CLI, you must run the install script for the new CLI, as the versions are not backwards compatible. Proofs submitted by the old CLI will not receive rewards in Testnet III.

If you encounter any issues:

Check Documentation

Get Help

Overview

Proving on the Layer 1

Building on the Layer 1

Earn NEX Points

Contribute via CLI

Introduction

Install Script

System Requirements

Setup & Configuration

Troubleshooting

Overview

Proving on the Layer 1

Building on the Layer 1

Earn NEX Points

​Introduction

​Install Script

​System Requirements

​Setup & Configuration

​Troubleshooting

Introduction

Install Script

System Requirements

Setup & Configuration

Troubleshooting