This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Tools

Meet the Wasmflow tools.

1 - Wafl

The Wasmflow utility binary.

wafl (lovingly pronounced “waffle”) is the Wasmflow utility binary. It is an RPC client, project bootstrapper, and registry manipulator (among other things).

You don’t need wafl to run wasmflow. It can be distributed or updated on its own and omitted from deployments.

USAGE

wafl <COMMAND> <SUBCOMMAND>

Subcommands

rpc

The rpc subcommands connect to a remote wasmflow host and issue an RPC request.

  • rpc invoke: Invoke a component on the remote host.
  • rpc list: Retrieve the list of exposed components on the remote host.
  • rpc stats: Get the running statistics of the remote host.

project

The project subcommands houses functions that help you build, deploy, and maintain applications.

  • project new: Create a new Wasmflow project.

component

The component subcommands help you build new components in an existing project.

  • component new: Create a new schema for a Wasmflow component.

registry

registry subcommands are for interacting with an OCI registry.

  • registry push: Push an image to an OCI registry.
  • registry pull: Pull an image from an OCI registry.

wasm

Wafl’s wasm subcommands help you sign, inspect, and manage WasmFlow WebAssembly artifacts.

  • wasm sign: Sign a .wasm file with local keys.
  • wasm inspect: Inspect the embedded details of a signed Wasmflow .wasm file.

bundle

The bundle subcommands help you manage native, multi-architecture binary collections.

  • bundle pack: Create a signed archive bundle.

help

Prints the help message with more details on commands and arguments.

2 - Wasmflow

The Wasmflow host.

wasmflow is the runtime executor for Wasmflow manifests and WebAssembly collections.

USAGE

wasmflow <SUBCOMMAND>

Subcommands

serve

Start a persistent host from a manifest or .wasm module, optionally exposing an RPC microservice or connecting to a mesh of hosts across a message queue.

invoke

Invoke a component exposed in a manifest or a .wasm module.

list

Print the components exposed by a manifest or a .wasm module.

test

Load a manifest or .wasm module and run automated unit tests against its components.

help

Prints this message or the help of the given subcommand(s)