2024-10-23 18:47:15 +00:00
|
|
|
# Network CLI
|
2024-09-05 19:45:22 +00:00
|
|
|
|
2024-10-23 18:47:15 +00:00
|
|
|
The command line interface (CLI) lets you run a Nexus prover node.
|
|
|
|
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](https://brew.sh/) to manage packages on OS X,
|
|
|
|
run this command to install Git.
|
|
|
|
|
|
|
|
```
|
|
|
|
brew install git
|
|
|
|
```
|
|
|
|
|
|
|
|
### Windows
|
|
|
|
|
|
|
|
[Install WSL](https://learn.microsoft.com/en-us/windows/wsl/install),
|
|
|
|
then see Linux instructions above.
|
2024-09-05 19:45:22 +00:00
|
|
|
|
|
|
|
## Quick start
|
|
|
|
|
|
|
|
```
|
2024-10-18 19:41:20 +00:00
|
|
|
curl https://cli.nexus.xyz/ | sh
|
2024-09-05 19:45:22 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
If you do not already have Rust, you will be prompted to install it.
|
|
|
|
|
2024-10-03 22:31:23 +00:00
|
|
|
## Terms of Use
|
|
|
|
|
2024-10-23 18:47:15 +00:00
|
|
|
Use of the CLI is subject to the [Terms of Use](https://nexus.xyz/terms-of-use).
|
2024-10-03 22:31:23 +00:00
|
|
|
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),
|
2024-10-09 00:47:55 +00:00
|
|
|
add `NONINTERACTIVE=1` before `sh`.
|
2024-10-03 22:31:23 +00:00
|
|
|
|
2024-09-05 19:45:22 +00:00
|
|
|
## Known issues
|
|
|
|
|
2024-10-23 18:47:15 +00:00
|
|
|
* Only the latest version of the CLI is currently supported.
|
|
|
|
* Prebuilt binaries are not yet available.
|
2024-10-27 21:56:19 +00:00
|
|
|
* Linking email to prover id is currently available on the web version only.
|
2024-10-23 18:47:15 +00:00
|
|
|
* Counting cycles proved is not yet available in the CLI.
|
|
|
|
* Only proving is supported. Submitting programs to the network is in private beta.
|
2024-10-18 19:25:25 +00:00
|
|
|
To request an API key, contact us at growth@nexus.xyz.
|
2024-10-23 18:47:15 +00:00
|
|
|
|
|
|
|
## Resources
|
|
|
|
|
|
|
|
* [Network FAQ](https://nexus.xyz/network#network-faqs)
|
|
|
|
* [Discord channel](https://discord.gg/nexus-xyz)
|