willsm/network-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update installation instructions

Browse Source
This commit is contained in:
Collin Jackson 2024-10-20 23:29:19 -07:00
parent 7b3383123c
commit c27be89ba3
1 changed files with 34 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
clients/cli/README.md
View File

@ -1,6 +1,28 @@
# network-cli
# Network CLI
Command line interface (CLI) for accessing the Nexus Network. Highest-performance option for proving.
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.
### Mac
If you have [installed Homebrew](https://brew.sh/) to manage packages on OS X,
follow these instructions to install Git:
```
brew install git
```
### Linux
```
sudo apt update
sudo apt upgrade
sudo apt install build-essential pkg-config libssl-dev git-all
```
## Quick start
@ -10,14 +32,21 @@ curl https://cli.nexus.xyz/ | sh
If you do not already have Rust, you will be prompted to install it.
## Terms of Use
## Terms of use
Use of the CLI is subject to the [Terms of Use](https://nexus.xyz/terms_of_use).
Use of the CLI is subject to the [Terms of Use](https://nexus.xyz/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
Currently only proving is supported. Submitting programs to the network is in private beta.
* Only the latest version of the CLI is currently supported.
* Prebuilt binaries are not yet available.
* Only proving is supported. Submitting programs to the network is in private beta.
To request an API key, contact us at growth@nexus.xyz.
## Resources
* [Network FAQ](https://nexus.xyz/network#network-faqs)
* [Discord channel](https://discord.gg/nexus-xyz)