Skip to content

Update README.md #326

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.

Sign up for GitHub

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

Merged
Meshiest merged 1 commit into from
May 1, 2025
Merged

Update README.md #326

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To learn more about `snops` we recommend checking out the mdbook [here](https://
The controlplane is the webserver that communicates to agents how to
run snarkOS, or what transactions to execute.

1. In another terminal, install the cli: `cargo install --path ./crates/snops-cli`, or build with `cargo xtask build cli` and use from `target/release-big/snops-cli`.
1. In another terminal, install the cli: `cargo install --path ./crates/cli`, or build with `cargo xtask build cli` and use from `target/release-big/snops-cli`.

The cli is used to interact with the controlplane and manage environments.
It provides JSON based output. We recommend pairing our cli with [`jq`](https://jqlang.github.io/jq/) when leveraging other scripts and tools
Expand All @@ -55,10 +55,10 @@ To learn more about `snops` we recommend checking out the mdbook [here](https://
1. In separate terminals, start up some agents with the following commands:

```sh
./script/agent.sh 0
./script/agent.sh 1
./script/agent.sh 2
./script/agent.sh 3
./scripts/agent.sh 0
./scripts/agent.sh 1
./scripts/agent.sh 2
./scripts/agent.sh 3
```

Each of these can be dynamically configured as snarkos nodes. The default
Expand All @@ -81,7 +81,7 @@ been more convenient. Snops aliases locally generated keys automatically from co
reduces the need to keep track of individual key files.

1. Start an environment (see previous example)
1. Start a compute agent: `./scripts/agent_compute.sh 0`
1. Start a compute agent: `./scripts/compute_agent.sh 0`

Compute agents are able to distribute the execution of transactions,
offloading the compute task to different servers.
Expand Down
Loading