Skip to content

Update CLI run documentation #10793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 20, 2025

Conversation

alexcrichton
Copy link
Member

Try to take the spirit of #10792 to improve our documentation for the run command and how CLI arguments interact with the provided WebAssembly module.

@alexcrichton alexcrichton requested a review from a team as a code owner May 18, 2025 22:04
@alexcrichton alexcrichton requested review from dicej and removed request for a team May 18, 2025 22:04
@github-actions github-actions bot added the wasmtime:docs Issues related to Wasmtime's documentation label May 18, 2025
Copy link
Contributor

@abrown abrown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the nits!


A Wasm **module** exports raw functions directly. The `run` command accepts an optional `--invoke` argument, which is the name of an exported raw function (of the module) to run:
WebAssembly modules or components can behave like a "command" which means
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just wondering: isn't there some WASI repository page somewhere that we can link to here in case anyone wants to dig into the difference between command and reactor components?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @abrown ,

I think this was mentioned in this comment - WebAssembly/WASI#13 (comment)

So i think this the right repository - https://github.com/WebAssembly/component-model

There is post on blog for this topic which helped me to understand this topic - https://wasmcloud.com/blog/webassembly-patterns-command-reactor-library/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll update this to remove the "command" terminology since that's now-dated and instead just say "CLI program" in a few places here. I'd prefer to not have to bring up commands/reactors if possible since they're ideally only a historical feature.

Try to take the spirit of bytecodealliance#10792 to improve our documentation for the
`run` command and how CLI arguments interact with the provided
WebAssembly module.
@alexcrichton alexcrichton enabled auto-merge May 20, 2025 13:58
@alexcrichton alexcrichton added this pull request to the merge queue May 20, 2025
Merged via the queue into bytecodealliance:main with commit fd28db3 May 20, 2025
41 checks passed
@alexcrichton alexcrichton deleted the doc-run-more branch May 20, 2025 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wasmtime:docs Issues related to Wasmtime's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants