History

Diego Prats 18b3754709 Update clients/cli/src/analytics.rs Co-authored-by: Collin Jackson <collin@nexus.xyz>		2024-11-12 17:03:45 -08:00
..
src	Update clients/cli/src/analytics.rs	2024-11-12 17:03:45 -08:00
.gitignore	feat: Initial check-in of prover CLI (#2 )	2024-09-05 12:45:22 -07:00
build.rs	feat!: Update README with latest naming, prompting for acceptance of terms, noninteractive mode, replace keep_proving with just_once (#5 )	2024-10-03 15:31:23 -07:00
Cargo.lock	ci: automatically lint and build CLI (#33 )	2024-11-08 13:45:30 -08:00
Cargo.toml	ci: automatically lint and build CLI (#33 )	2024-11-08 13:45:30 -08:00
README.md	docs: Update Discord link text (#20 )	2024-10-29 10:55:02 -07:00

README.md

Network CLI

The command line interface (CLI) lets you run a prover node and contribute proofs to the Nexus network. It is the highest-performance option for proving.

Prerequisites

If you don't have these dependencies already, install them first.

Linux

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

macOS

If you have installed Homebrew to manage packages on OS X, run this command to install Git.

brew install git

Windows

Install WSL, then see Linux instructions above.

Quick start

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

If you do not already have Rust, you will be prompted to install it.

Terms of Use

Use of the CLI is subject to the Terms of Use. The first time you run it, it prompts you to accept the terms. To accept the terms noninteractively (for example, in a continuous integration environment), add NONINTERACTIVE=1 before sh.

Known issues

Only the latest version of the CLI is currently supported.
Prebuilt binaries are not yet available.
Linking email to prover id is currently available on the web version only.
Counting cycles proved is not yet available in the CLI.
Only proving is supported. Submitting programs to the network is in private beta. To request an API key, contact us at growth@nexus.xyz.