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.

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

Jump to bottom

chore(docs): aztec-up doesnt need latest, remove warnings around sandbox/cli npm pkgs #4138

Merged
merged 1 commit into from
Jan 18, 2024
Merged

chore(docs): aztec-up doesnt need latest, remove warnings around sandbox/cli npm pkgs #4138

Show file tree
Hide file tree
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
22 changes: 0 additions & 22 deletions docs/docs/dev_docs/cli/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,6 @@ Here you will find a reference to the commands available in the Aztec CLI.

The CLI will be installed automatically via Docker by running the command to install and start the sandbox, [instructions here](./sandbox-reference.md#with-docker).

:::info

The `@aztec/aztec-sandbox` and `@aztec/cli` packages published to npm **should not be used**, in favor of Docker. If you've installed the sandbox or the CLI via NPM, **uninstall** them and remove them from your project dependencies and [install via Docker](./sandbox-reference.md#with-docker).

<Tabs>
<TabItem value="yarn" label="yarn" default>

<code>
yarn global remove @aztec/aztec-sandbox @aztec/cli
</code>

</TabItem>
<TabItem value="npm" label="npm">

<code>
npm -g uninstall @aztec/aztec-sandbox @aztec/cli
</code>

</TabItem>
</Tabs>
:::

## Update

The CLI comes with an update command.
Expand Down
34 changes: 7 additions & 27 deletions docs/docs/dev_docs/updating.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,12 @@
title: Updating
---

:::info
The `@aztec/aztec-sandbox` and `@aztec/cli` packages published to npm **should not be used**, in favor of Docker. If you've installed the sandbox or the CLI via NPM, **uninstall** them and remove them from your project dependencies and [install via Docker](./cli/sandbox-reference.md#with-docker).

<Tabs>
<TabItem value="yarn" label="yarn" default>

<code>
yarn global remove @aztec/aztec-sandbox @aztec/cli
</code>

</TabItem>
<TabItem value="npm" label="npm">

<code>
npm -g uninstall @aztec/aztec-sandbox @aztec/cli
</code>

</TabItem>
</Tabs>

:::

## TL;DR

1. Updating the sandbox and CLI:

```shell
aztec-up latest
aztec-up
```

2. Updating aztec-nr and individual @aztec dependencies:
Expand All @@ -47,13 +25,15 @@ The sandbox must be running for the update command to work. Make sure it is [ins

---

There are three components whose versions need to be kept compatible:
There are four components whose versions need to be kept compatible:
Copy link
Contributor

@jzaki jzaki Jan 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to distinguish between aztec-nargo -V vs aztec-<other> -V versions? The former being Noir language version (eg 0.23.0), the latter cli, sandbox, etc (eg 0.19.0)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good call! Feel free to open another PR that addresses this.


1. Aztec Sandbox
2. Aztec CLI
3. `Aztec.nr`, the Noir framework for writing Aztec contracts
3. aztec-nargo
4. `Aztec.nr`, the Noir framework for writing Aztec contracts

All three are using the same versioning scheme and their versions must match. Docker ensures that the sandbox and CLI are always compatible, but you need to update Aztec.nr manually or using `aztec-cli update`.
First three are packaged together in docker and are kept compatible by running `aztec-up`.
But you need to update your Aztec.nr version manually or using `aztec-cli update`.

## Updating Aztec.nr packages

Expand Down Expand Up @@ -91,5 +71,5 @@ If the dependencies fail to resolve ensure that the tag matches a tag in the [az
`aztec-nargo` is updated by running:

```bash
aztec-up latest
aztec-up
```
18 changes: 5 additions & 13 deletions yarn-project/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,12 @@
The Aztec CLI `aztec-cli` is a command-line interface (CLI) tool for interacting with Aztec. It provides various commands for deploying contracts, creating accounts, interacting with contracts, and retrieving blockchain data.

## Installation
1. In your terminal, download the sandbox by running
```
bash -i <(curl -s install.aztec.network)
```

To use `aztec-cli`, you need to have Node.js installed on your system. Follow these steps to install and set up the CLI tool:

1. Install Node.js: Visit the official Node.js website (https://nodejs.org) and download the installer for your operating system. Follow the installation instructions to install Node.js.

2. Install `aztec-cli` package: Open a terminal or command prompt and run the following command to install `aztec-cli` globally on your system:

```shell
npm install -g @aztec/cli
```

This will install the `aztec-cli` globally, making it accessible from any location in your terminal.

3. Verify the installation: After the installation is complete, run the following command to verify that `aztec-cli` is installed correctly:
2. Verify the installation: After the installation is complete, run the following command to verify that `aztec-cli` is installed correctly:

```shell
aztec-cli --version
Expand Down
Loading