Skip to content

docs: add documentation for parse, validate, and instantiate subcommands#295

Open
Divyansh200102 wants to merge 1 commit intoWasmEdge:mainfrom
Divyansh200102:docs/add-parse-validate-instantiate-subcommands
Open

docs: add documentation for parse, validate, and instantiate subcommands#295
Divyansh200102 wants to merge 1 commit intoWasmEdge:mainfrom
Divyansh200102:docs/add-parse-validate-instantiate-subcommands

Conversation

@Divyansh200102
Copy link
Copy Markdown

Explanation

Adds documentation for the three new CLI subcommands (parse, validate, instantiate) introduced in WasmEdge/WasmEdge#4694. Also updates the main CLI page to list all available subcommands.

Related issue

Closes WasmEdge/WasmEdge#4688

What type of PR is this

/kind documentation

Proposed Changes

  • Added parse.md — documents the wasmedge parse subcommand, which displays a WASM module's section details (types, imports, functions, globals, exports, code, custom sections).
  • Added validate.md — documents the wasmedge validate subcommand, which checks a WASM module against the spec without executing it.
  • Added instantiate.md — documents the wasmedge instantiate subcommand, which loads, validates, and instantiates a module (with multi-module linking support via --module).
  • Updated cli.md — added a subcommands table linking to all five subcommand pages, and updated the USAGE block to reflect the new CLI structure.

Each new page follows the same structure and conventions as the existing subcommands documentations.

Signed-off-by: divyanshi.khatri <divyanshi.khatri@servicenow.com>
@Divyansh200102
Copy link
Copy Markdown
Author

The following example .wat files are placeholders for now and will be added as examples in the main PR.

  • parse_example.wat (used in parse.md)
  • bad_validate.wat (used in validate.md)
  • bad_instantiate.wat (used in instantiate.md)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

LFX Workspace: Extend sub-command of WasmEdge CLI tool

1 participant