Update CLI commands to use stable v3.0.0 release#918
Merged
Conversation
Replace 3.0.0-rc.0 and other v3 prerelease versions with 3.0.0, and remove the explicit version pin from `pnpx envio@... init` commands for v3 (v2 init commands keep `envio@2`).
Remove the `--api-token ""` placeholder from all init commands and prose, and trim the surrounding explanation in the AI quickstart so it no longer references the empty-string trick. Also split the release-notes list so v3.0.0 and v3.0.0-rc.0 appear as separate entries.
Drop "Available since 3.0.0." from the Solana experimental callout so it just reads "Experimental.". In the AI quickstart and Environment Variables guides (v2 and v3), clarify that the API token is only required when using Envio HyperSync as the data provider — indexers using an external RPC don't need one and can pass an empty string to skip the prompt.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📝 WalkthroughWalkthroughThis PR systematically updates all HyperIndex documentation and blog content to use unpinned ChangesCLI Unpinning and API Token Clarification
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
docs/HyperIndex-LLM/hyperindex-complete.mdx (1)
1562-1562: ⚡ Quick winPrefer environment variables over
--api-tokenin docs examples.Using
--api-tokenin command examples (for example Line 1562 and Line 9178) encourages putting secrets in shell history and process args. PreferENVIO_API_TOKEN+ command without inline token flags.♻️ Suggested doc update pattern
-pnpx envio init template --name alchemy-migration --directory alchemy-migration --template greeter --api-token "YOUR_ENVIO_API_KEY" +export ENVIO_API_TOKEN=YOUR_ENVIO_API_KEY +pnpx envio init template --name alchemy-migration --directory alchemy-migration --template greeter-pnpx envio init template -n erc20-example -t erc20 -l typescript -d erc20-indexer --api-token "your-api-token" && cd erc20-indexer && pnpm dev +ENVIO_API_TOKEN=your-api-token pnpx envio init template -n erc20-example -t erc20 -l typescript -d erc20-indexer && cd erc20-indexer && pnpm devAlso applies to: 9178-9193, 9199-9208, 9214-9221
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/HyperIndex-LLM/hyperindex-complete.mdx` at line 1562, Replace inline --api-token usage in the example command (the line containing pnpx envio init template --name alchemy-migration --directory alchemy-migration --template greeter --api-token "YOUR_ENVIO_API_KEY") with an environment-variable approach: show exporting ENVIO_API_TOKEN (e.g., export ENVIO_API_TOKEN="YOUR_ENVIO_API_KEY" or the Windows equivalent) and then run the pnpx envio init template command without the --api-token flag; apply the same change to the other occurrences mentioned (the blocks around the other examples) so examples use ENVIO_API_TOKEN instead of passing the token on the command line.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@blog/2026-04-24-clickhouse-storage.md`:
- Line 79: Update the surrounding wording so it matches the stable semantics of
the unpinned command "pnpx envio init": replace any references to "latest alpha
release" with the stable release wording (e.g., "stable v3.0.0" or "stable
release") and, if you want to show a pinned alternative, add a note explaining
how to call a specific version (e.g., mention using a versioned pnpx invocation)
while keeping the displayed command "pnpx envio init" as the unpinned, stable
install flow.
In `@docs/HyperIndexV2/Guides/environment-variables.md`:
- Line 27: Update the contradictory guidance so the page consistently states
that ENVIO_API_TOKEN is required only when using Envio as the data provider
(HyperSync) and not for all self-hosted deployments; find the section mentioning
ENVIO_API_TOKEN (the sentence at Line 33) and revise its wording to match Line
27’s rule (“A token is only required when using Envio/HyperSync”), removing any
phrasing that implies self-hosted instances always need the token and, if
present, add a short clarifier that RPC-backed indexers do not require
ENVIO_API_TOKEN.
In `@docs/HyperIndexV2/solana/solana.md`:
- Line 21: The docs currently show an unpinned CLI invocation "pnpx envio init
svm" which may resolve to envio v3; update the command to pin the major version
by replacing that invocation with "pnpx envio@2 init svm" (search for the
literal "pnpx envio init svm" in the file and change it to the pinned form) so
the v2 docs scaffold the correct major version.
---
Nitpick comments:
In `@docs/HyperIndex-LLM/hyperindex-complete.mdx`:
- Line 1562: Replace inline --api-token usage in the example command (the line
containing pnpx envio init template --name alchemy-migration --directory
alchemy-migration --template greeter --api-token "YOUR_ENVIO_API_KEY") with an
environment-variable approach: show exporting ENVIO_API_TOKEN (e.g., export
ENVIO_API_TOKEN="YOUR_ENVIO_API_KEY" or the Windows equivalent) and then run the
pnpx envio init template command without the --api-token flag; apply the same
change to the other occurrences mentioned (the blocks around the other examples)
so examples use ENVIO_API_TOKEN instead of passing the token on the command
line.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2aeef2d3-91a8-4bdd-a861-38857ce51889
📒 Files selected for processing (28)
blog/2025-12-16-dev-update-december-2025.mdblog/2026-03-20-agentic-blockchain-indexing.mdblog/2026-03-23-dev-update-march-2026.mdblog/2026-04-24-clickhouse-storage.mddocs/HyperIndex-LLM/hyperindex-complete.mdxdocs/HyperIndex/Guides/cli-commands.mddocs/HyperIndex/Guides/contract-state.mddocs/HyperIndex/Guides/environment-variables.mddocs/HyperIndex/Guides/ipfs.mddocs/HyperIndex/Guides/running-locally.mddocs/HyperIndex/Guides/testing.mdxdocs/HyperIndex/Tutorials/greeter-tutorial.mddocs/HyperIndex/Tutorials/price-data.mddocs/HyperIndex/Tutorials/tutorial-erc20-token-transfers.mddocs/HyperIndex/Tutorials/tutorial-indexing-fuel.mddocs/HyperIndex/Tutorials/tutorial-op-bridge-deposits.mddocs/HyperIndex/contract-import.mddocs/HyperIndex/migrate-from-alchemy.mddocs/HyperIndex/migrate-from-ponder.mddocs/HyperIndex/migrate-to-v3.mddocs/HyperIndex/migrate-with-ai.mddocs/HyperIndex/migration-guide.mddocs/HyperIndex/quickstart-with-ai.mddocs/HyperIndex/solana/solana.mddocs/HyperIndex/whats-new-in-v3.mddocs/HyperIndexV2/Guides/environment-variables.mddocs/HyperIndexV2/quickstart-with-ai.mddocs/HyperIndexV2/solana/solana.md
|
|
||
| ```bash | ||
| pnpx envio@3.0.0-rc.0 init | ||
| pnpx envio init |
Contributor
There was a problem hiding this comment.
Update surrounding wording to match stable command semantics.
Line 79 now uses unpinned pnpx envio init, but the nearby setup text still says “latest alpha release,” which conflicts with the stable v3.0.0 positioning and can confuse readers.
Suggested doc tweak
-This will set up a fresh project on the latest alpha release.
+This will set up a fresh project on the latest stable release.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@blog/2026-04-24-clickhouse-storage.md` at line 79, Update the surrounding
wording so it matches the stable semantics of the unpinned command "pnpx envio
init": replace any references to "latest alpha release" with the stable release
wording (e.g., "stable v3.0.0" or "stable release") and, if you want to show a
pinned alternative, add a note explaining how to call a specific version (e.g.,
mention using a versioned pnpx invocation) while keeping the displayed command
"pnpx envio init" as the unpinned, stable install flow.
|
|
||
| - Use `ENVIO_API_TOKEN` to provide your token at runtime | ||
| - See the API Tokens guide for how to generate a token: [API Tokens](/docs/HyperSync/api-tokens) | ||
| - A token is only required when using Envio as the data provider (HyperSync). Indexers that source data from an external RPC don't need one. |
Contributor
There was a problem hiding this comment.
Resolve token requirement contradiction within this page.
The new statement on Line 27 conflicts with Line 33, which still implies self-hosted deployments always need ENVIO_API_TOKEN. Please align Line 33 to the same rule (“required only when using HyperSync as provider”) to avoid mixed guidance.
Suggested doc adjustment
-- `ENVIO_API_TOKEN`: API token for HyperSync access (required for continued access in self-hosted deployments)
+- `ENVIO_API_TOKEN`: API token for HyperSync access (required when using HyperSync as the data provider; not required when using an external RPC)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/HyperIndexV2/Guides/environment-variables.md` at line 27, Update the
contradictory guidance so the page consistently states that ENVIO_API_TOKEN is
required only when using Envio as the data provider (HyperSync) and not for all
self-hosted deployments; find the section mentioning ENVIO_API_TOKEN (the
sentence at Line 33) and revise its wording to match Line 27’s rule (“A token is
only required when using Envio/HyperSync”), removing any phrasing that implies
self-hosted instances always need the token and, if present, add a short
clarifier that RPC-backed indexers do not require ENVIO_API_TOKEN.
|
|
||
| ```bash | ||
| pnpx envio@3.0.0-alpha.14 init svm | ||
| pnpx envio init svm |
Contributor
There was a problem hiding this comment.
Pin v2 docs to envio@2 to avoid scaffolding the wrong major version.
Line 21 currently uses unpinned pnpx envio init svm, which can resolve to v3 and conflicts with v2 docs expectations.
Proposed fix
-pnpx envio init svm
+pnpx envio@2 init svm📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| pnpx envio init svm | |
| pnpx envio@2 init svm |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/HyperIndexV2/solana/solana.md` at line 21, The docs currently show an
unpinned CLI invocation "pnpx envio init svm" which may resolve to envio v3;
update the command to pin the major version by replacing that invocation with
"pnpx envio@2 init svm" (search for the literal "pnpx envio init svm" in the
file and change it to the pinned form) so the v2 docs scaffold the correct major
version.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
This PR updates documentation across multiple files to reflect the stable v3.0.0 release of Envio. All references to the release candidate version (
3.0.0-rc.0) and alpha versions are replaced with the stable3.0.0version or simplified to use the latest version viapnpx envio init.Key Changes
pnpx envio@3.0.0-rc.0withpnpx envioto use the latest stable version by defaultenvio: "3.0.0"instead of3.0.0-rc.0--api-tokenflag is optional when using external RPC sources and removed misleading examples of passing empty stringsNotable Details
pnpx envio initwill automatically resolve to the latest stable versionhttps://claude.ai/code/session_019gANhHF3h2PqMMB554zFWQ
Summary by CodeRabbit
ENVIO_API_TOKENis only needed when using Envio's HyperSync as data provider, not required for external RPC indexers.pnpx envio init svm.