- When running examples in this repository, use the
Justfilerecipes instead of invokingcargo runorpythondirectly. - Use
just examplesfrom the repository root to run the full example suite. - To run examples for a specific sandbox, use module-scoped recipes:
just wasm examples,just js examples,just python examples,just dotnet examples. - Use
just buildfrom the repository root to build all subprojects and SDKs. - Reason: the example commands depend on
WIT_WORLDbeing set tosrc/wasm_sandbox/wit/sandbox-world.wasm; theJustfilehandles that setup.
Make things cross-platform where possible (window/mac/linux). Mac supprot for hyperlight isn't avaliable yet but is coming.
-
After changing WIT interfaces: you must run
just build(or at minimum rebuild the guest.wasmand.aotfiles) before running examples. The pre-compiled guest binaries embed the WIT signature; a mismatch causes "Host function vector parameter missing length" errors at runtime. -
Formatting and linting: always use
just fmtandjust fmt-checkfrom the repository root instead of invokingcargo fmt,ruff format,ruff check, ordotnet formatdirectly. The Justfile recipes run multiple tools in sequence and missing a step causes CI failures.