wasmCloud/wasmCloud
{ "createdAt": "2020-10-15T17:41:17Z", "defaultBranch": "main", "description": "wasmCloud is an open source Cloud Native Computing Foundation (CNCF) project that enables teams to build, manage, and scale polyglot apps across any cloud, K8s, or edge.", "fullName": "wasmCloud/wasmCloud", "homepage": "https://wasmcloud.com", "language": "Rust", "name": "wasmCloud", "pushedAt": "2026-03-20T14:54:09Z", "stargazersCount": 2258, "topics": [ "cloud-native", "distributed", "edge", "kubernetes", "nats", "platform", "wasm-native", "webassembly" ], "updatedAt": "2026-03-21T23:21:25Z", "url": "https://github.com/wasmCloud/wasmCloud"}wash - The Wasm Shell
Section titled “wash - The Wasm Shell”wash is the comprehensive command-line tool for developing, building, and managing WebAssembly components. It provides an intuitive developer experience for the modern Wasm ecosystem, from project scaffolding to building and pushing components to OCI registries.
Features
Section titled “Features”- Project Creation: Generate new WebAssembly component projects from templates
- Multi-Language Build System: Compile components for multiple languages (Rust, Go, TypeScript)
- Development Loop: Built-in hot-reload development server (
wash dev) - OCI Registry Integration: Push and pull components to/from OCI-compatible registries
- Component Inspection: Analyze component WIT interfaces and metadata
- Configuration Management: Hierarchical configuration with global and project-level settings
- Self-Updates: Keep wash up-to-date with the latest features and fixes
Installation
Section titled “Installation”Pre-built Binaries
Section titled “Pre-built Binaries”Download the latest release for your platform from GitHub Releases.
Install
Section titled “Install”Quick install (latest release)
Linux/macOS:
curl -fsSL https://raw.githubusercontent.com/wasmcloud/wasmCloud/refs/heads/main/install.sh | bashWindows (PowerShell):
iwr -useb https://raw.githubusercontent.com/wasmcloud/wasmCloud/refs/heads/main/install.ps1 | iexMake sure to move wash to somewhere in your PATH.
From Source
Section titled “From Source”git clone https://github.com/wasmcloud/wasmCloud.gitcd wasmCloudcargo install --path .Quickstart
Section titled “Quickstart”Note: This quickstart requires the Rust toolchain and the wasm32-wasip2 target for Rust: rustup target add wasm32-wasip2
-
Create a new component:
Terminal window wash new https://github.com/wasmCloud/wasmCloud.git --subfolder examples/http-hello-world -
Build your component:
Terminal window wash -C ./http-hello-world build -
Start a development loop
Terminal window wash -C ./http-hello-world dev -
Keep wash updated:
Terminal window wash update
Commands
Section titled “Commands”| Command | Description |
|---|---|
wash build | Build a Wasm component |
wash config | View and manage wash configuration |
wash completion | Generate shell completion scripts for wash |
wash dev | Start a development server for a Wasm component with hot-reload |
wash host | Act as a host. |
wash new | Create a new project from a git repository |
wash oci | Push or pull Wasm components to/from an OCI registry |
wash update | Update wash to the latest version |
wash wit | Manage WIT dependencies |
wash help | Print this message or the help of the given subcommand(s) |
Run wash --help or wash help <command> for detailed usage information.
Shell Completion
Section titled “Shell Completion”For zsh completion, please run:
mkdir -p ~/.zsh/completionwash completion zsh > ~/.zsh/completion/_washand put the following in ~/.zshrc:
fpath=(~/.zsh/completion $fpath)Note if you’re not running a distribution like oh-my-zsh you may first have to enable autocompletion (and put in ~/.zshrc to make it persistent):
autoload -Uz compinit && compinitTo enable bash completion, run the following, or put it in ~/.bashrc or ~/.profile:
. <(wash completion bash)The below commands can be used for fish auto completion:
mkdir -p ~/.config/fish/completionswash completion fish > ~/.config/fish/completions/wash.fishPowershell
Section titled “Powershell”The below command can be referred for setting it up. Please note that the path might be different depending on your system settings.
wash completion powershell > $env:UserProfile\\Documents\\WindowsPowerShell\\Scripts\\wash.ps1Architecture
Section titled “Architecture”wash is built with the following key principles:
- Component-First: Native support for the WebAssembly Component Model
- Language Agnostic: Support for Rust, Go (TinyGo), TypeScript, and more
- OCI Compatible: Components are stored and distributed using OCI registries
- Portable Components: Produces WebAssembly components that are runtime-agnostic and compatible with any Component Model runtime
- Wasmtime-Powered: Uses Wasmtime for local component execution and development workflows
- Extensible: Plugin system allows integration with different platforms and workflows
- Developer Experience: Hot-reload development loops and comprehensive tooling
Wash & Kubernetes
Section titled “Wash & Kubernetes”Start kind cluster:
make kind-setupInstall chart with pre-configured values:
make helm-installWait for all pods to come online.
Check if hosts registered correctly:
❯ kubectl get hostNAME HOSTID HOSTGROUP READY AGEthinkable-zebra-8670 8247719b-0d85-4940-a03d-7076e045d5ac default True 64suppity-religion-0822 3c2a7116-05fd-4f2f-9e6b-8291bd018fb7 default True 66svivacious-band-6937 eb27df8b-c5b0-48a3-bafe-a7e92eb19746 default True 66sDocumentation
Section titled “Documentation”- WebAssembly Component Model - Learn about the component model
- WASI Preview 2 - WebAssembly System Interface
- wasmCloud Documentation - Platform integration via plugins
- [Contributing Guide]!(CONTRIBUTING.md) - How to contribute to this project
Support
Section titled “Support”- GitHub Issues - Bug reports and feature requests
- GitHub Discussions - Community support and Q&A
- WebAssembly Community - Broader WebAssembly ecosystem
License
Section titled “License”This project is licensed under the Apache License 2.0 - see the [LICENSE]!(LICENSE) file for details.