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.
- Ubuntu/Debian
- Fedora
- MacOS
- Windows
- Rust
- Source
- Docker Compose
curl -s https://packagecloud.io/install/repositories/wasmcloud/core/script.deb.sh | sudo bash
sudo apt install wash
Details
curl -s https://packagecloud.io/install/repositories/wasmcloud/core/script.rpm.sh | sudo bash
sudo dnf install wash
Details
brew install wasmcloud/wasmcloud/wash
For the smoothest experience, we recommend that Windows users run wasmCloud with Windows Subsystem for Linux (WSL) and follow the Ubuntu/Debian instructions throughout the documentation.
Microsoft provides documentation for getting started with WSL and using WSL with Visual Studio Code.
When using WSL, we recommend choosing the Ubuntu
distro (wsl --install -d Ubuntu
).
You may need to update git
to the latest version using the Ubuntu Git Maintainers' Personal Package Archive (PPA):
sudo add-apt-repository ppa:git-core/ppa
sudo apt-get update
sudo apt-get install git
When your WSL environment is ready, you can use the standard Ubuntu/Debian installation method:
curl -s https://packagecloud.io/install/repositories/wasmcloud/core/script.deb.sh | sudo bash
sudo apt install wash
If you are unable to use WSL, you can use the native binary installation below, but note that native Windows support is experimental.
choco install wash
If you're using the native Windows binary, you can install wasmCloud's supported language toolchains on Windows as follows:
Go toolchain
On Windows, you can use Scoop to install the Go toolchain (as well as the binaryen
tool to compile components on Windows):
scoop install go
scoop install tinygo@0.33.0
scoop install binaryen
Rust toolchain
On Windows, you can use Chocolatey to install rustup
, and then use rustup
to install the Windows toolchain:
choco install rustup.install
rustup toolchain install stable-msvc
Note: On Windows, you will also need Visual Studio's C++ tools.
Once you've installed Rust, use rustup
to add the wasm32-wasip2
target:
rustup target add wasm32-wasip2
TypeScript toolchain
On Windows, you can use Chocolatey to install npm
(and Node.js):
choco install nodejs
If your platform isn't listed, wash
can be installed with cargo
and a Rust toolchain.
cargo install --locked wash-cli
If you have cargo-binstall
installed, you can install even faster:
cargo binstall wash-cli
The wash project is open-source and can be cloned from GitHub and built locally with a Rust toolchain.
git clone https://github.com/wasmCloud/wasmCloud.git
cd wasmCloud/crates/wash-cli
cargo build --release
cd ../..
./target/release/wash
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.
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, 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.