feat: updated cli commands to include complete one liner examples#713
Merged
DenhamPreen merged 2 commits intomainfrom Oct 15, 2025
Merged
feat: updated cli commands to include complete one liner examples#713DenhamPreen merged 2 commits intomainfrom
DenhamPreen merged 2 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
WalkthroughDocumentation-only edits: expanded CLI examples into “Complete One-Line Examples,” removed two supported-network rows in two docs pages, added dark-mode DocSearch CSS tweaks, and reformatted Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (5)
💤 Files with no reviewable changes (2)
✅ Files skipped from review due to trivial changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Comment on lines
+331
to
332
| pnpx envio init contract-import local -n my-indexer -a ./abis/MyContract.json -c 0xYourContractAddress -b ethereum-mainnet --contract-name MyContract --single-contract --all-events -l typescript -d my-indexer --api-token "your-api-token" && cd my-indexer && pnpm dev | ||
| ``` |
Contributor
There was a problem hiding this comment.
Remove the unsupported -c flag from the local ABI example.
Line 331’s one-liner includes -c 0xYourContractAddress, but the options table for envio init contract-import local (Lines 114‑119) doesn’t list -c/--contract-address; that flag only belongs to the parent contract-import command. Keeping it here will cause the CLI to error out. Please drop the -c argument (or document the correct flag if one exists).
🤖 Prompt for AI Agents
In docs/HyperIndex/Guides/cli-commands.md around lines 331 to 332, the local ABI
example includes the unsupported -c 0xYourContractAddress flag which will cause
the CLI to error; remove the `-c 0xYourContractAddress` segment from the
one-liner (or replace it with the correct parent-level flag only in the parent
command docs) so the example matches the available options for `envio init
contract-import local`.
keenbeen32
force-pushed
the
kv/one-line-init-doc
branch
from
ba0daf1 to
9c26ec4
Compare
DenhamPreen
approved these changes
Oct 15, 2025
This was referenced Oct 30, 2025
Merged
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
2 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.
Just added some more examples for how to create indexers in one terminal command for ai's benefit
Summary by CodeRabbit