Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,525 Commits
.github		.github
benchmarks		benchmarks
bin		bin
builders		builders
docs		docs
exe		exe
ext/ruby_wasm		ext/ruby_wasm
lib		lib
packages		packages
rakelib		rakelib
sig		sig
test		test
.clang-format		.clang-format
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
Gemfile		Gemfile
LICENSE		LICENSE
NOTICE		NOTICE
README.md		README.md
Rakefile		Rakefile
Steepfile		Steepfile
package-lock.json		package-lock.json
package.json		package.json
ruby_wasm.gemspec		ruby_wasm.gemspec
sbom.spdx.json		sbom.spdx.json

Repository files navigation

ruby.wasm

ruby.wasm is a collection of WebAssembly ports of theCRuby.It enables running Ruby application on browsers, WASI compatible WebAssembly runtimes, and Edge Computing platforms.

Try ruby.wasm (no installation needed)

Try ruby.wasm inTryRuby in your browser.

Quick Links

Quick Example: Ruby on Web browser

Create and saveindex.html page with the following contents:

<html><scriptsrc="https://cdn.jsdelivr.net/npm/@ruby/3.4-wasm-wasi@2.7.2/dist/browser.script.iife.js"></script><scripttype="text/ruby">require"js"putsRUBY_VERSION #(PrintedtotheWebbrowserconsole)JS.global[:document].write"Hello, world!"</script></html>

Quick Example: How to package your Ruby application as a WASI application

Dependencies:wasmtime

$gem install ruby_wasm#Download a prebuilt Ruby release$curl -LO https://github.com/ruby/ruby.wasm/releases/latest/download/ruby-3.4-wasm32-unknown-wasip1-full.tar.gz$tar xfz ruby-3.4-wasm32-unknown-wasip1-full.tar.gz#Extract ruby binary not to pack itself$mv ruby-3.4-wasm32-unknown-wasip1-full/usr/local/bin/ruby ruby.wasm#Put your app code$mkdir src$echo"puts 'Hello'"> src/my_app.rb#Pack the whole directory under /usr and your app dir$rbwasm pack ruby.wasm --dir ./src::/src --dir ./ruby-3.4-wasm32-unknown-wasip1-full/usr::/usr -o my-ruby-app.wasm#Run the packed scripts$wasmtime my-ruby-app.wasm /src/my_app.rbHello

npm packages (for JavaScript host environments)

See theREADME.md of each package for more detail and its usage.

Package	Description	npm
@ruby/3.4-wasm-wasi	CRuby 3.4 built on WASI with JS interop support
@ruby/3.3-wasm-wasi	CRuby 3.3 built on WASI with JS interop support
@ruby/3.2-wasm-wasi	CRuby 3.2 built on WASI with JS interop support
@ruby/head-wasm-wasi	HEAD CRuby built on WASI with JS interop support
@ruby/head-wasm-emscripten	HEAD CRuby built on Emscripten (not well tested)

Prebuilt binaries

This project distributesprebuilt Ruby binaries in GitHub Releases.Abuild is a combination of ruby version,profile, andtarget.

Supported Target Triples

Triple	Description
`wasm32-unknown-wasip1`	TargetingWASI Preview1 compatible environments (e.g. Node.js, browsers with polyfill,wasmtime, and so on)
`wasm32-unknown-emscripten`	Targeting JavaScript environments including Node.js and browsers

Profiles

Profile	Description
`minimal`	No standard extension libraries (like`json`,`yaml`, or`stringio`)
`full`	All standard extension libraries

Notable Limitations

The current WASI target build does not yet supportThread related APIs. Specifically, WASI does not yet have an API for creating and managing threads yet.

Also there is no support for networking. It is one of the goal of WASI to support networking in the future, but it is not yet implemented.

Contributing

SeeCONTRIBUTING.md for how to build and test, and how to contribute to this project.Bug reports and pull requests are welcome on GitHub athttps://github.com/ruby/ruby.wasm