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.
- 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
- Plugin System: Extensible architecture with WebAssembly-based plugins
- Component Inspection: Analyze component WIT interfaces and metadata
- Environment Health Checks: Built-in diagnostics and system verification
- Configuration Management: Hierarchical configuration with global and project-level settings
- Self-Updates: Keep wash up-to-date with the latest features and fixes
Download the latest release for your platform from GitHub Releases.
Quick install (latest release)
Linux/macOS:
curl -fsSL https://raw.githubusercontent.com/wasmcloud/wash/refs/heads/main/install.sh | bashWindows (PowerShell):
iwr -useb https://raw.githubusercontent.com/wasmcloud/wash/refs/heads/main/install.ps1 | iexMake sure to move wash to somewhere in your PATH.
git clone https://github.com/wasmcloud/wash.git
cd wash
cargo build --release-
Check your environment:
wash doctor
-
Create a new component:
wash new
-
Build your component:
wash build ./http-hello-world
-
Start a development loop
wash dev ./http-hello-world
-
Keep wash updated:
wash update
| Command | Description |
|---|---|
wash build |
Build a Wasm component |
wash config |
View and manage wash configuration |
wash dev |
Start a development server for a Wasm component with hot-reload |
wash doctor |
Check the health of your wash installation and environment |
wash inspect |
Inspect a Wasm component's embedded WIT interfaces |
wash new |
Create a new project from a template or git repository |
wash oci |
Push or pull Wasm components to/from an OCI registry |
wash plugin |
Manage wash plugins |
wash update |
Update wash to the latest version |
wash help |
Print this message or the help of the given subcommand(s) |
Run wash --help or wash <command> --help for detailed usage information.
wash also supports custom commands through its plugin system. Plugins are automatically discovered and made available as subcommands.
wash features an extensible plugin architecture built on WebAssembly:
- Built-in Plugins: oauth, blobstore-filesystem, aspire-otel
- Platform Integration: Plugins can integrate wash with specific platforms (like wasmCloud)
- Custom Plugins: Write your own plugins using the WebAssembly Component Model
- Automatic Discovery: Plugins in the
plugins/directory are automatically loaded - Hook System: Plugins can register pre and post-command hooks for workflow customization
Use wash plugin --help to see plugin management commands.
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
- WebAssembly Component Model - Learn about the component model
- WASI Preview 2 - WebAssembly System Interface
- wasmCloud Documentation - Platform integration via plugins
- Contributing Guide - How to contribute to this project
- GitHub Issues - Bug reports and feature requests
- GitHub Discussions - Community support and Q&A
- WebAssembly Community - Broader WebAssembly ecosystem
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.