cranelift/docs/cli.md

# Using the `wasmtime` CLI

In addition to the embedding API which allows you to use Wasmtime as a
library, the Wasmtime project also provides a `wasmtime` CLI tool to conveniently
execute WebAssembly modules from the command line.

This section will provide a guide to the `wasmtime` CLI and major functionality
that it contains. In short, however, you can execute a WebAssembly file
(actually doing work as part of the `start` function) like so:

```sh
$ wasmtime foo.wasm
```

Or similarly if you want to invoke a "start" function, such as with WASI
modules, you can execute

```sh
$ wasmtime --invoke _start foo.wasm
```

For more information be sure to check out [how to install the
CLI](cli-install.md), [the list of options you can
pass](cli-options.md), and [how to enable logging](cli-logging.md).
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 5 years ago			# Using the `wasmtime` CLI

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 5 years ago			`In addition to the embedding API which allows you to use Wasmtime as a`
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. 5 years ago			library, the Wasmtime project also provides a `wasmtime` CLI tool to conveniently
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 5 years ago			`execute WebAssembly modules from the command line.`

			This section will provide a guide to the `wasmtime` CLI and major functionality
			`that it contains. In short, however, you can execute a WebAssembly file`
			(actually doing work as part of the `start` function) like so:

			```sh
			`$ wasmtime foo.wasm`
			```

			`Or similarly if you want to invoke a "start" function, such as with WASI`
			`modules, you can execute`

			```sh
			`$ wasmtime --invoke _start foo.wasm`
			```

			`For more information be sure to check out [how to install the`
Log to stderr by default. (#1266) Change the default from file-per-thread-logger to pretty-env-logger, which is more common in Rust projects, and change the option from `-d` to `--log-to-files`. 5 years ago			`CLI](cli-install.md), [the list of options you can`
			`pass](cli-options.md), and [how to enable logging](cli-logging.md).`