Installation

We will guide you through installation of wash, the wasmCloud Shell, which gives you the tools to install, run, and develop with wasmCloud.

Ubuntu/Debian

caution

wasmCloud requires an OpenSSL 1.1 compatible version on Linux. If you're running Ubuntu 22.04+ or equivalent, you'll need to follow the steps in this issue to install a compatible OpenSSL version.

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

Fedora

caution

wasmCloud requires an OpenSSL 1.1 compatible version on Linux. If you're running Fedora 36+ or equivalent, you'll need to follow the steps in this issue to install a compatible OpenSSL version.

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

Snap

snap install wash --devmode --edge

MacOS

brew tap wasmcloud/wasmcloud
brew install wash openssl@1.1

Windows

choco install wash

Rust

If your platform isn't listed, wash can be installed with cargo and a Rust toolchain. Ensure you install OpenSSL 1.1 on your system as well to run the wasmCloud host.

cargo install wash-cli

Source

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.

Docker Compose

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

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