Skip to content

docs: list --allow-af-unix and the coredump options in the CLI page - #318

Merged
hydai merged 1 commit into
WasmEdge:mainfrom
rawsun007:cli-missing-options
Oct 28, 2026
Merged

hydai merged 1 commit into
WasmEdge:mainfrom
rawsun007:cli-missing-options

Conversation

@rawsun007

Copy link
Copy Markdown
Contributor

Explanation

wasmedge --help lists --allow-af-unix, --enable-coredump and --coredump-for-wasmgdb, but the options list on the wasmedge CLI page does not mention them. This adds them.

Related issue

None.

What type of PR is this

/kind documentation

Proposed Changes

Add an "Other options" item to the options list in docs/start/build-and-run/cli.md, with the three options. The descriptions follow include/driver/tool.h and lib/driver/runtimeTool.cpp. I checked the coredump behaviour with the 0.18.1 darwin_arm64 release on a module whose _start traps:

  • --enable-coredump writes coredump.<timestamp> to the current directory.
  • --coredump-for-wasmgdb on its own also writes one.
  • With --run-mode=jit, it prints the interpreter-only warning and writes no file.

--forbidden-plugin is also missing from this page. I left it out because it currently has no effect on the official plug-ins (wasi_nn, wasi_crypto, wasmedge_image and the others in lib/vm/plugin_modules.cpp), so "list of plugins to ignore" would overstate it.

This contribution was developed with assistance from Claude Code (Claude Opus 5.5).

Assisted-by: Claude (Anthropic)
Signed-off-by: Roshan Ramani <roshanramani.dev@gmail.com>
@hydai
hydai merged commit 8baf9aa into WasmEdge:main Oct 28, 2026
6 checks passed
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.

2 participants