From 497a64e7a2e85b42bff552dd0f931b1e4aeefdd7 Mon Sep 17 00:00:00 2001 From: benesjan Date: Thu, 14 Sep 2023 09:31:05 -0400 Subject: [PATCH] WIP --- docs/docs/dev_docs/getting_started/cli.md | 16 ++++++++++++++-- docs/docs/dev_docs/getting_started/sandbox.md | 8 ++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/docs/dev_docs/getting_started/cli.md b/docs/docs/dev_docs/getting_started/cli.md index 810e992183cd..d89a063c2457 100644 --- a/docs/docs/dev_docs/getting_started/cli.md +++ b/docs/docs/dev_docs/getting_started/cli.md @@ -24,10 +24,22 @@ Or if you use yarn: yarn global add @aztec/cli ``` -Then verify that it is installed with: +If you have specified a SANDBOX_VERSION environmental variable when installing sandbox, you will need to specify the same version when installing the CLI. For example: ```bash -aztec-cli -h +npm install -g @aztec/cli@0.7.0 +``` + +or if you use yarn: + +```bash +yarn global add @aztec/cli@0.7.0 +``` + +Verify that the correct version is installed: + +```bash +aztec-cli --version ``` ## I have the Sandbox running, now what? diff --git a/docs/docs/dev_docs/getting_started/sandbox.md b/docs/docs/dev_docs/getting_started/sandbox.md index 3873fb6ffef0..fc675f840557 100644 --- a/docs/docs/dev_docs/getting_started/sandbox.md +++ b/docs/docs/dev_docs/getting_started/sandbox.md @@ -383,6 +383,14 @@ Alternatively you can open a new terminal and use aztec-cli to get the version. aztec-cli get-node-info ``` +:::note + +Versions of `sandbox` and `aztec-cli` must match. +If `aztec-cli --version` does not return the same version as `SANDBOX_VERSION` then you need to install the correct version of `aztec-cli`. +See [this section](./cli.md#requirements) for how to accomplish that. + +::: + ## Next Steps Here we showed how to interact with the sandbox, but didn't go into details on how to write your own contract or any relevant setup needed for it.