Running with Docker (macOS/Windows)

Yeet requires a Linux kernel, so it can't run natively on macOS or Windows. The easiest way to get a working environment is the demo container in yeet-scripts, which ships with yeet pre-installed and all the example scripts baked in.

Prerequisites

• Docker

Setup

Clone the repo and boot the container:

git clone https://github.com/yeet-src/yeet-scripts.git
cd yeet-scripts
make

make builds and launches the container and drops you into an interactive shell. From there you can run any script:

yeet run examples/proctop/render.js
yeet run examples/docker-net/render.js
yeet run examples/metropolis.js

To rebuild the image after making changes:

make build

To launch an already-built image:

make run