Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: More explanation of source modification #59

Merged
merged 4 commits into from
Nov 22, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions clients/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,20 @@ add `NONINTERACTIVE=1` before `sh`.
* Only proving is supported. Submitting programs to the network is in private beta.
To request an API key, contact us at [email protected].

## Building and running from source
## Modifying source

The curl command in the quick start section downloads this repo to $HOME/.nexus/network-api
and automatically builds it. If you want to modify the CLI, it's better to clone the GitHub
repo somewhere else.

To run an optimized build using Nexus servers, run the following command in clients/cli:

```
cargo build
cargo run --release
cargo run --release -- beta.orchestrator.nexus.xyz
```

To run the CLI with tracing enabled, run:

To test against beta environment of the orchestrator, run:
```sh
cargo run -- beta.orchestrator.nexus.xyz
```
Expand Down