Update CLI `run` documentation (#10793)

* Update CLI `run` documentation

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

Update CLI `run` documentation (#10793)

* Update CLI `run` documentation

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.

* Review comments

show more ...

fix(docs): remove $ from console commands for easy copy/paste (#10653)

This PR does a couple things to make docs a bit easier to use:

- Switch from `sh` to `console` for console commands
- Remove `

fix(docs): remove $ from console commands for easy copy/paste (#10653)

This PR does a couple things to make docs a bit easier to use:

- Switch from `sh` to `console` for console commands
- Remove `$` from console commands that do not also have output

Generally, console commands that are standalone *should* be easy to
copy and paste.

This PR doesn't make the changes everywhere in the docs, but that can
be handled in follow-ups.

Signed-off-by: Victor Adossi <[email protected]>

show more ...

wasmtime-cli: support `run --invoke` for components using wave (#10054)

* wip

* invoke works!!!

* code motion

* more context in errors

* fix test of invoke

* Invoke wave enhancements (#10511)

wasmtime-cli: support `run --invoke` for components using wave (#10054)

* wip

* invoke works!!!

* code motion

* more context in errors

* fix test of invoke

* Invoke wave enhancements (#10511)

* wip

* wasmtime::component::Component: add iterator of exports

* components_rec

* exports_rec gives fully qualified name

* invoke works!!!

* code motion

* more context in errors

* fix test of invoke

* Finalized enhancements for --invoke: error messages

* Testing and documenting --invoke

* Update if else re: invoke

* Updating to fix truncation possibilities in unwrap_tuple

* Add clippy annotation to resolve CI error and leave original code (that makes 2 i64 out of 1 i128 and discards extra bits).

* Format (rustfmt --edition 2021) Rust files in this PR.

* Removing duplicate code missed from previous conflict resolution

* Add more verbose documentation

* Add more verbose documentation

---------

Co-authored-by: Pat Hickey <[email protected]>

* Convert docs and error trapping to single quote approach (#10533)

* Convert docs and error trapping to single quote approach

* Adjust the error message a little

* Respond to review (#10544)

* cli: search component for export items

---------

Co-authored-by: Timothy McCallum <[email protected]>

show more ...

Add a `wasmtime objdump` subcommand (#10405)

This commit adds an `objdump` subcommand to the `wasmtime` CLI. Like all
other subcommands this can be disabled for a more minimal build of the
CLI as we

Add a `wasmtime objdump` subcommand (#10405)

This commit adds an `objdump` subcommand to the `wasmtime` CLI. Like all
other subcommands this can be disabled for a more minimal build of the
CLI as well. The purpose of this subcommand is to provide a
Wasmtime-specific spin on the venerable native `objdump` itself. Notably
this brings Wasmtime-specific knowledge for filtering functions, showing
Wasmtime metadata, etc.

This command is intended to look like `objdump` roughly but also has
configurable output with various flags and things that can be printed.
For now the main Wasmtime additions are showing the address map
section, stack map section, and trap section of a `*.cwasm` file.

This new subcommand replaces the infrastructure of the `disas` test
suite, and now that test suite uses `wasmtime objdump` to generate test
expectations. Additionally the subcommand replaces the Pulley `objdump`
example as a more full-featured objdump that also works natively with
Pulley.

The hope is that if we add more binary metadata in the future (such as
unwinding tables) that can be relatively easily added here for
exploration as well. Otherwise this is mostly just a developer
convenience for Wasmtime developers as well and hopefully doesn't cost
too much in maintenance burden.

Closes #10336

show more ...

Document precedence order of CLI/config options (#10269)

Closes #10258

Make TOML config keys kebab-case, and add docs (#10132)

* Update cli book docs for toml option

* Make TOML keys use kebab-case in order to match cli names

Document `wasmtime serve` (#8077)

* Document `wasmtime serve`

* Mention `component` instead of `module`

Mention --invoke on "CLI Options for `wasmtime`" page (#3828)

* Document the invoke argument of the run command.

* Update docs/cli-options.md

Co-authored-by: Kyle Brown <[email protected]

Mention --invoke on "CLI Options for `wasmtime`" page (#3828)

* Document the invoke argument of the run command.

* Update docs/cli-options.md

Co-authored-by: Kyle Brown <[email protected]>
Co-authored-by: Nick Fitzgerald <[email protected]>

show more ...

Remove the `wasmtime wasm2obj` command (#3301)

* Remove the `wasmtime wasm2obj` command

This commit removes the `wasm2obj` subcommand of the `wasmtime` CLI.
This subcommand has a very long histo

Remove the `wasmtime wasm2obj` command (#3301)

* Remove the `wasmtime wasm2obj` command

This commit removes the `wasm2obj` subcommand of the `wasmtime` CLI.
This subcommand has a very long history and dates back quite far. While
it's existed, however, it's never been documented in terms of the output
it's produced. AFAIK it's only ever been used for debugging to see the
machine code output of Wasmtime on some modules. With recent changes to
the module serialization output the output of `wasmtime compile`, the
`*.cwasm` file, is now a native ELF file which can be fed to standard
tools like `objdump`. Consequently I dont think there's any remaining
need to keep `wasm2obj` around itself, so this commit removes the
subcommand.

* More code to delete

* Try to fix debuginfo tests

show more ...

Sort output in `wasmtime settings`.

This commit sorts the settings output by the `wasmtime settings` command.

Add a compile command to Wasmtime.

This commit adds a `compile` command to the Wasmtime CLI.

The command can be used to Ahead-Of-Time (AOT) compile WebAssembly modules.

With the `all-arch` feature

Add a compile command to Wasmtime.

This commit adds a `compile` command to the Wasmtime CLI.

The command can be used to Ahead-Of-Time (AOT) compile WebAssembly modules.

With the `all-arch` feature enabled, AOT compilation can be performed for
non-native architectures (i.e. cross-compilation).

The `Module::compile` method has been added to perform AOT compilation.

A few of the CLI flags relating to "on by default" Wasm features have been
changed to be "--disable-XYZ" flags.

A simple example of using the `wasmtime compile` command:

```text
$ wasmtime compile input.wasm
$ wasmtime input.cwasm
```

show more ...

Miscelaneous docs updates and fixes. (#1249)

Update references to things in CraneStation which have moved, WASI documentation
which has moved to the WASI repo, and fix a few typos.

Spice up the project README, fill out more docs (#1010)

* Spice up the project README, fill out more docs

This is an attempt to spruce up wasmtime's README.md file as well as
fill out more of th

Spice up the project README, fill out more docs (#1010)

* Spice up the project README, fill out more docs

This is an attempt to spruce up wasmtime's README.md file as well as
fill out more of the missing documentation in the `docs/` folder.
There's still a long way to go but I hoped here to mostly move around
existing information and add new information. As always happy to have
feedback!

* Tweak CLI wording

* Remove no-longer relevant clause

* Update sandboxing docs

* Handle comments

show more ...

Add book documentation skeleton and auto-publish from CI (#435)

This commit adds the skeleton of a new set of documentation for
`wasmtime` in the existing `docs` directory. This documentation is
o

Add book documentation skeleton and auto-publish from CI (#435)

This commit adds the skeleton of a new set of documentation for
`wasmtime` in the existing `docs` directory. This documentation is
organized and compiled with [mdbook] which the Rust project uses for
most of its own documentation as well. At a previous meeting we
brainstormed a rough skeleton of what the documentation in this book
would look like, and I've transcribed that here for an example of how
this is rendered and how it can be laid out. No actual documentation is
written yet.

This commit also additionally adds necessary support to auto-publish
both this book documentation and API documentation every time a commit
is pushed to the `master` branch. All HTML will be automatically pushed
to the `gh-pages` branch so long as the CI passes, and this should get
deployed to https://cranestation.github.io/wasmtime.

I've done a few dry-runs and I think this'll all work, but we'll likely
tweak a few things here and there after running this through CI to make
sure everything looks just as we'd like. My hope though is that after
this lands we can start actually filling out all the documentation and
being able to review it as well.

[mdbook]: https://crates.io/crates/mdbook

show more ...