Skip to content

Commit

Permalink
describing how to get a version
Browse files Browse the repository at this point in the history
  • Loading branch information
benesjan committed Sep 15, 2023
1 parent b881fdc commit 0a86c68
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/docs/dev_docs/getting_started/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,26 @@ Or if you use yarn:
yarn global add @aztec/cli
```

If you have specified a SANDBOX_VERSION environmental variable when installing the Sandbox, you will need to specify the same version when installing the CLI. For example:
If you have specified a SANDBOX_VERSION environmental variable when installing the Sandbox, you will need to specify the same version when installing the CLI.
To get the version of the Sandbox you have installed start the Sandbox and look for the version in the logs.
Alternatively, if you already have a version of aztec-cli installed, you can run:

#include_code node-info yarn-project/end-to-end/src/cli_docs_sandbox.test.ts bash

To install a specific version of the CLI, run:

```bash
npm install -g @aztec/cli@0.7.0
npm install -g @aztec/cli@YOUR_VERSION
```

or if you use yarn:

```bash
yarn global add @aztec/cli@0.7.0
yarn global add @aztec/cli@YOUR_VERSION
```

If your version was not found look at the list of available versions on [npmjs.com](https://www.npmjs.com/package/@aztec/cli?activeTab=versions).

Verify that the correct version is installed:

```bash
Expand Down
5 changes: 5 additions & 0 deletions docs/docs/dev_docs/getting_started/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,11 @@ 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.

To get the version of the Sandbox you have installed start the Sandbox and look for the version in the logs.
Alternatively you can use `aztec-cli`:

#include_code node-info yarn-project/end-to-end/src/cli_docs_sandbox.test.ts bash

:::

## Next Steps
Expand Down

0 comments on commit 0a86c68

Please sign in to comment.