Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 3.22 KB

README.md

File metadata and controls

91 lines (63 loc) · 3.22 KB

Nexus Network CLI

A high-performance command-line interface for contributing proofs to the Nexus network.

Nexus Network visualization showing a distributed network of interconnected nodes with a 'Launch Network' button in the center Verifiable Computation on a Global Scale
We're building a global distributed prover network to unite the world's computers and power a new and better Internet: the Verifiable Internet. Connect to the beta and give it a try today.

The Nexus Network

The Nexus Network is a global distributed prover network that unites the world's computers to power a new and better Internet: the Verifiable Internet.

There have been two testnets:

Important: The Nexus network is currently in devnet. It is important to note that you cannot earn Nexus points. Instead, devnet allows developers to experiment and build with the network. Stay tuned for updates regarding future testnets.

Quick Start

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

If you don't have Rust installed, you will be prompted to install it.

Prerequisites

Linux

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

macOS

brew install git

Windows

Install WSL first, then follow Linux instructions.

Terms of Use

Use of the CLI is subject to the Terms of Use. First-time users will be prompted to accept the terms. For non-interactive acceptance (e.g., CI environments), use:

NONINTERACTIVE=1 sh

Prover Id

The CLI will prompt for your web prover id from the Nexus testnet or devnet on startup. It is ok to skip this prompt and a random id will be generated, but you'll be prompted again on startup until your web prover id is entered.

The prover id prompt is disabled when NONINTERACTIVE=1 is set. In a server environment, you can manually overwrite $HOME/.nexus/prover-id with your full prover id.

Current Limitations

  • Only latest CLI version is supported
  • No prebuilt binaries yet
  • Proof cycle counting coming soon
  • Program submission requires API key (contact growth@nexus.xyz)

Get Help

Repository Structure

network-api/
├── assets/       # Media for documentation
├── clients/
│   └── cli/      # Main CLI implementation
├── proto/        # Shared network interface definition
└── public/       # Files hosted at cli.nexus.xyz

Contributing

See CONTRIBUTING.md for development setup and guidelines.