Contribute via CLI

Introduction

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

CLI nodes connecting to Nexus

Install Script

Quick install (scripted):

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

After installing, restart or refresh your terminal (e.g. source ~/.bashrc, source ~/.zshrc, etc.). To start with an existing node ID:

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

Alternatively, register your wallet address and create a node ID with the CLI, or 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

Setup & Configuration

1

Initial setup

  1. Run the CLI for the first time.

  2. Accept the Terms of Use.

  3. Choose between anonymous or linked proving (see the next step).

2

Choose proving mode

You have two options:

  • Link to Nexus Account (Recommended)

    • 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

Known issues & help
  • 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.

  • Check Documentation:

  • Get Help:


Related:

  • Contribute via Web App: https://docs.nexus.xyz/layer-1/testnet/web-node

  • FAQ: https://docs.nexus.xyz/layer-1/testnet/faq

Last updated