add runner script and docs

Pi-Squared-Inc · Dec 9, 2024 · b08e386 · b08e386
1 parent e2166d7
commit b08e386
Show file tree

Hide file tree

Showing 3 changed files with 570 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -171,6 +171,18 @@ The target `test` contains all the currently passing tests.
 make test
 ```
 
+To execute the Wasm VM locally, you can use the `wasm` Poetry script from the repo root as follows:
+
+```sh
+poetry -C pykwasm run wasm <llvm-build-dir> <wasm-file> [-cellname:sort=cellvalue...]
+```
+
+For example, after locally building the ULM-integrated Wasm, the local build of the ULM-integrated Wasm can be executed as follows:
+
+```sh
+poetry -C pykwasm run wasm ./build/wasm pykwasm/src/tests/integration/binary/basic-features.wat -gas:Int=0 -create:Bool=false -entry:String=init
+```
+
 Resources
 ---------
 

diff --git a/pykwasm/pyproject.toml b/pykwasm/pyproject.toml
@@ -11,6 +11,7 @@ authors = [
 ]
 
 [tool.poetry.scripts]
+wasm = "pykwasm.run_wasm:main"
 wasm2kast = "pykwasm.wasm2kast:main"
 kwasm = "pykwasm.scripts.kwasm:main"
 kwasm-convert = "pykwasm.scripts.convert:main"