Installation

First, we'll install wash, the WAsmcloud SHell, which we'll use to install, run, and manage our wasmCloud components. Select your preferred installation method below, then run the displayed commands in your favorite terminal.

curl -s https://packagecloud.io/install/repositories/wasmcloud/core/script.deb.sh | sudo bash
sudo apt install wash

curl -s https://packagecloud.io/install/repositories/wasmcloud/core/script.rpm.sh | sudo bash
sudo dnf install wash

snap install wash --devmode --edge

brew tap wasmcloud/wasmcloud
brew install wash

choco install wash

If your platform isn't listed, wash can be installed with cargo and a Rust toolchain.

cargo install wash-cli

The wash repository is open-source and can be cloned from GitHub and built locally with a Rust toolchain.

git clone https://github.com/wasmcloud/wash.git
cd wash
cargo build --release
./target/release/wash

info

You'll also want to add wash to your PATH to easily run it. Refer to instructions specific to your operating system for how to do this.

caution

If you only use Docker Compose without installing wash, you'll only be able to interact with wasmCloud via the washboard.

Download the sample Docker Compose file and put it into your work directory. This compose file will run NATS, a local OCI registry, a Redis container, Grafana and Tempo for OTEL, and the wasmcloud_host container. In this format it's easy to run all the necessary services for a wasmCloud host with only a docker installation.

With the docker-compose.yml file in the current directory, start the processes with

docker compose up

The host will run until you type Ctrl-C or close the terminal window. To start the docker compose process in the background, add a -d flag:

docker compose up -d

If the wasmCloud host is running in docker in the background, you can view its logs (live) with

docker logs -f wasmcloud

Verify that wash is properly installed with:

wash --help

If wash is installed correctly, you will see a printout of all available commands and short descriptions for each. If you ever need more detail on a specific command or sub-command just run wash <command> --help.

Now that wash is installed, let's get started.