Update to use pnpx and pnpm everywhere for envio command. #526
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
JasoonS
commented
Nov 8, 2024
| @@ -9,6 +9,8 @@ slug: /cli-commands | |||
|
|
|||
| This document contains the help content for the `envio` command-line program. | |||
|
|
|||
| **_Note:_** `envio` is an executable, but it is recommended to always run `pnpx envio@latest` for the init command and `pnpm envio` when interacting with a specific repo. This ensures that you are using an up to date version for new projects, and use the correct version of the envio executable for local project you may look at. | |||
There was a problem hiding this comment.
This is the only file that I did not add pnpm or pnpx to.
JasoonS
commented
Nov 8, 2024
| @@ -13,8 +13,7 @@ import TabItem from "@theme/TabItem"; | |||
| Once the configuration and schema files are in place, run: | |||
|
|
|||
| ```bash | |||
| envio codegen | |||
| ``` | |||
| pnpm envio codegen``` | |||
DZakh
requested changes
Nov 8, 2024
| @@ -7,15 +7,15 @@ slug: /generated-files | |||
|
|
|||
| # Generated files | |||
|
|
|||
| The `/generated` directory contains essential files required for performing the indexing process in Envio. These files are automatically generated using the `envio codegen` CLI command and they should NOT be modified by the end user. | |||
| The `/generated` directory contains essential files required for performing the indexing process in Envio. These files are automatically generated using the `pnpm envio codegen` CLI command and they should NOT be modified by the end user. | |||
There was a problem hiding this comment.
Suggested change
| The `/generated` directory contains essential files required for performing the indexing process in Envio. These files are automatically generated using the `pnpm envio codegen` CLI command and they should NOT be modified by the end user. | |
| The `/generated` directory contains essential files required for performing the indexing process in Envio. These files are automatically generated using the `pnpm codegen` CLI command and they should NOT be modified by the end user. |
There was a problem hiding this comment.
Should we maybe even skip envio and have pnpm codegen?
Comment on lines
23
to
+24
| 1. Install Envio via `npm i -g [email protected]` | ||
| 1. Generate indexing code via `envio codegen` | ||
| 1. Run the indexer via `envio dev` (make sure you have Docker running) | ||
| 1. Stop the indexer via `envio stop` | ||
| 1. Generate indexing code via `pnpm envio codegen` |
| ``` | ||
|
|
||
| or | ||
|
|
||
| ``` | ||
| export ENVIO_PG_PORT=5433 | ||
| envio codegen | ||
| envio dev | ||
| pnpm envio codegenpnpm envio dev |
| @@ -58,16 +58,14 @@ If Postgres is running locally on port 5432, then you can run the whole system w | |||
| In practice, this could look like this: | |||
|
|
|||
| ``` | |||
| ENVIO_PG_PORT=5433 envio codegen | |||
| ENVIO_PG_PORT=5433 envio dev | |||
| ENVIO_PG_PORT=5433 pnpm envio codegenENVIO_PG_PORT=5433 pnpm envio dev | |||
| @@ -47,7 +47,7 @@ More information on [the Quickstart](./contract-import) can be found in this doc | |||
|
|
|||
| ### Templates | |||
|
|
|||
| Select either the `ERC20`, `Greeter`, or `Blank` template following the `envio init` command. | |||
| Select either the `ERC20`, `Greeter`, or `Blank` template following the `pnpx envio | |||
| @@ -9,7 +9,7 @@ slug: /benchmarking | |||
|
|
|||
| ### Capturing the benchmark | |||
|
|
|||
| You can run `envio start --bench` to capture some benchmarking data while your indexer is running. This should not be run in production, since it holds each benchmark data point in memory and adds some overhead in writing to a file. | |||
| You can run `pnpm envio start --bench` to capture some benchmarking data while your indexer is running. This should not be run in production, since it holds each benchmark data point in memory and adds some overhead in writing to a file. | |||
There was a problem hiding this comment.
The only downside of dropping envio and having only pnpm start is that flags won't work in this case.
| @@ -21,7 +21,7 @@ Before we start indexing, you'll need to make sure you have the [prerequisites]( | |||
|
|
|||
| Now that you have installed the prerequisite packages required, let’s jump into the practical steps of setting up the indexer. | |||
|
|
|||
| 1. Open your terminal in an empty repository and initialize a new indexer by running the command ‘envio init’ | |||
| 1. Open your terminal in an empty repository and initialize a new indexer by running the command ‘pnpx envio@latest init’ | |||
There was a problem hiding this comment.
I'd skip latest for simplicity, as I understand it works good with pnpx
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.