Skip to content

A lightweight WebAssembly runtime that is fast, secure, and standards-compliant

docs: document the CLI completion subcommand (#13033)

Solidity Phantome70a31a2bb15
diff --git a/docs/cli-options.md b/docs/cli-options.md
index 46ba328269..72bab12e99 100644
--- a/docs/cli-options.md
+++ b/docs/cli-options.md
@@ -200,6 +200,25 @@ wasmtime config new
And that'll print out the path to the file you can edit.
+## `completion`
+
+This subcommand generates shell completion scripts for the `wasmtime` CLI.
+Shells install completion scripts in different locations, so refer to your
+shell's documentation for the right place to store or evaluate the generated
+output.
+
+For example, to install completions for the `fish` shell:
+
+```console
+wasmtime completion fish > ~/.config/fish/completions/wasmtime.fish
+```
+
+For shells such as `zsh`, the generated script can also be evaluated directly:
+
+```console
+eval "$(wasmtime completion zsh)"
+```
+
## `compile`
This subcommand is used to Ahead-Of-Time (AOT) compile a WebAssembly module to produce