Introduction

Wasmer is a standalone JIT WebAssembly runtime, aiming to be fully compatible with WASI and Emscripten.

Install Wasmer with:

curl https://get.wasmer.io -sSfL | sh

NEW ✨: You can now embed Wasmer in your Rust application, check our example repo to see how!

Usage

Wasmer can execute both the standard binary format (.wasm) and the text format defined by the WebAssembly reference interpreter (.wat).

Once installed, you will be able to run any WebAssembly files (including nginx and Lua!):

# Run Lua
wasmer run examples/lua.wasm

# Run nginx
wasmer run examples/nginx/nginx.wasm -- -p examples/nginx -c nginx.conf

Code Structure

Wasmer is structured into different directories:

• src: code related to the Wasmer executable itself
• lib: modularized libraries that Wasmer uses under the hood
• examples: some useful examples to getting started with Wasmer

Dependencies

Building Wasmer requires rustup.

To build on Windows, download and run rustup-init.exe then follow the onscreen instructions.

To build on other systems, run:

curl https://sh.rustup.rs -sSf | sh

Other dependencies

Please select your operating system:

• macOS
• Debian-based Linuxes
• Microsoft Windows

macOS

If you have Homebrew installed:

brew install cmake

Or, in case you have MacPorts:

sudo port install cmake

Debian-based Linuxes

sudo apt install cmake

Windows (MSVC)

Windows support is highly experimental. Only simple Wasm programs may be run, and no syscalls are allowed. This means nginx and Lua do not work on Windows. See this issue regarding Emscripten syscall polyfills for Windows.

1. Install Visual Studio

2. Install Rust for Windows

3. Install Python for Windows. The Windows x86-64 MSI installer is fine. Make sure to enable "Add python.exe to Path" during installation.

4. Install Git for Windows. Allow it to add git.exe to your PATH (default settings for the installer are fine).

5. Install CMake. Ensure CMake is in your PATH.

6. Install LLVM 7.0

Building

Wasmer is built with Cargo, the Rust package manager.

# checkout code
git clone https://github.com/wasmerio/wasmer.git
cd wasmer

# install tools
# make sure that `python` is accessible.
cargo install --path .

Testing

Thanks to spec tests we can ensure 100% compatibility with the WebAssembly spec test suite.

Tests can be run with:

make test

If you need to regenerate the Rust tests from the spec tests you can run:

make spectests

You can also run integration tests with:

make integration-tests

Benchmarking

Benchmarks can be run with:

cargo bench --all

Roadmap

Wasmer is an open project guided by strong principles, aiming to be modular, flexible and fast. It is open to the community to help set its direction.

Below are some of the goals of this project (in order of priority):

• It should be 100% compatible with the WebAssembly spec tests
• It should be fast (partially achieved)
• Support WASI (in the works)
• Support Emscripten calls (in the works)
• Support Rust ABI calls
• Support Go ABI calls

Architecture

If you would like to know how Wasmer works under the hood, please see ARCHITECTURE.md.

License

Wasmer is primarily distributed under the terms of the MIT license (LICENSE).

ATTRIBUTIONS