add docs + setup for improving debugging

extism · Nov 28, 2024 · 624d3d4 · 624d3d4
1 parent 7b225fd
commit 624d3d4
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/.envrc.example b/.envrc.example
@@ -0,0 +1 @@
+export EXTISM_ENABLE_WASI_OUTPUT=1 # Enable WASI output for debugging
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ target
 Cargo.lock
 extism-py
 examples/*.wasm
+.envrc
diff --git a/README.md b/README.md
@@ -349,6 +349,11 @@ extism call out.wasm count_vowels --wasi --input='Hello World Test!'
 # => "{\"count\":4}"
 ```
 
+### Debugging
+
+To improve your debugging experience and get more information for panics
+and crashes, you should set the `EXTISM_ENABLE_WASI_OUTPUT` env var.
+
 ## How it works
 
 This works a little differently than other PDKs. You cannot compile Python to
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export EXTISM_ENABLE_WASI_OUTPUT=1 # Enable WASI output for debugging