Wasmin a contains a collection of packages and building blocks for running WASI WebAssembly applications on top of JavaScript Runtimes.
Main package implementing the WASI layer is @netapplabs/wasi-js with support for Preview 1 and experimental support for Preview 2 and component mode.
This repo is structured as a monorepo using Yarn and turborepo.
Each package/app written in TypeScript. It includes the following packages and apps:
@netapplabs/fs-js: Virtual FileSystem layer based on WHATWG File System Standard@netapplabs/node-fs-js: Implementation of File System Standard on top of Node File system@netapplabs/bun-fs-js: Implementation of File System Standard on top of Bun File I/O@netapplabs/deno-fs-js: Implementation of File System Standard on top of Deno File system APIs@netapplabs/nfs-js: Implementation of File System Standard for NFSv3 in pure WebAssembly@netapplabs/s3-fs-js: Implementation of File System Standard for S3 protocol.@netapplabs/wasi-js: WASI runtime layer written in TypeScript for JavaScript runtimes@netapplabs/shell: a CLI shell package for wasm/wasi embedding a pre-built Nushell shell compiled to WebAssembly by default.
Following applications are provided as examples for self contained executables built with the packages above.
@netapplabs/node-shell: a shell for wasm/wasi based on node.js@netapplabs/bun-shell: a shell for wasm/wasi based on bun.sh@netapplabs/deno-shell: a shell for wasm/wasi based on deno@netapplabs/web-shell: a Web shell for wasm/wasi runnable in a Browser.
Make sure you have in your ~/.npmrc
@netapplabs:registry=https://npm.pkg.github.com/
or if you have a GITHUB_TOKEN
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
@netapplabs:registry=https://npm.pkg.github.com/
Then add a package e.g. with
yarn add @netapplabs/wasi-jsor
bun add @netapplabs/wasi-jswasmin contains pre-built executables as an example built from the apps above in different formats:
docker run -it ghcr.io/netapplabs/wasmin:latestType in something like
help commands
to see available commands
docker run -it --mount type=bind,source=/Users/shared,target=/mount ghcr.io/netapplabs/wasmin:latest -pFor prebuilt with bun on macOS Apple Silicon:
wget https://github.com/NetAppLabs/wasmin/releases/download/latest/wasmin-bun-macos-arm64 -O wasmin
chmod +x wasmin
./wasmin -hFor prebuilt with bun on Linux Intel:
wget https://github.com/NetAppLabs/wasmin/releases/download/latest/wasmin-bun-linux-amd64 -O wasmin
chmod +x wasmin
./wasmin -hFor prebuilt with Node on macOS Apple Silicon:
wget https://github.com/NetAppLabs/wasmin/releases/download/latest/wasmin-node-macos-arm64 -O wasmin
chmod +x wasmin
./wasmin -hFor prebuilt with Node on Linux Intel:
wget https://github.com/NetAppLabs/wasmin/releases/download/latest/wasmin-node-linux-amd64 -O wasmin
chmod +x wasmin
./wasmin -hFor prebuilt with Deno on macOS Apple Silicon:
wget https://github.com/NetAppLabs/wasmin/releases/download/latest/wasmin-deno-macos-arm64 -O wasmin
chmod +x wasmin
./wasmin -hFor prebuilt with Deno on Linux Intel:
wget https://github.com/NetAppLabs/wasmin/releases/download/latest/wasmin-deno-linux-amd64 -O wasmin
chmod +x wasmin
./wasmin -hClone from github:
git clone [email protected]:NetAppLabs/wasmin.git
Export a GITHUB_TOKEN to your environment with read:packages scope.
export GITHUB_TOKEN=your_github_tokenSet up a modern Yarn environment depending on your JS runtime of choice:
- Node.js > 16.10:
corepack enable - Other JS runtimes: you may need to install corepack manually using your runtime and package manager of choice.
To build all apps and packages, run the following command:
cd wasmin
yarn
yarn build
To test all packages, run the following command:
cd wasmin
yarn test
Disclaimer: This is not an officially supported NetApp product.
See Contributing.md