Repository navigation
docs: correct the help, version and instantiate behavior in the CLI pages - #325
Merged
hydai merged 1 commit intoNov 20, 2026
Merged
Conversation
…ages The --help and --version options still parse the other arguments, so an unknown option or invalid value is an error, and instantiate runs the module's start function. Signed-off-by: Elvand Lie Nababan <elvandlie@gmail.com>
hydai
approved these changes
Nov 20, 2026
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
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.
Explanation
Two statements in the CLI pages do not match how
wasmedgebehaves.--helpand--versiondo not ignore the other arguments: they are still parsed, sowasmedge --help --unknownexits 1 withunknown option: unknown. Andwasmedge instantiatedoes run a function when the module has a start function: a trap there makes the command fail. This PR corrects the wording.Related issue
None.
What type of PR is this
/kind documentation
Proposed Changes
-v|--versionand-h|--helpshow their output and exit without running a program; the other arguments are still checked.instantiate.md.Validation
wasmedgebuilt from WasmEdge master5401b89d(Linux x86_64, CI imagewasmedge/wasmedge:ubuntu-24.04-build-gcc):wasmedge --helpwasmedge --help --unknownunknown option: unknownwasmedge --help --gas-limit abcinvalid integer value: abcwasmedge --help --gas-limit 5wasmedge --version --unknownunknown option: unknownwasmedge --version --gas-limit 5wasmedge instantiate start.wasmexecution failed: unreachablewasmedge instantiate simple.wasmInstantiation succeeded.start.wasmis(module (func $s unreachable) (start $s)).