# kettlecorn v0.1.0 - API Reference

## Modules

- [Kettlecorn](Kettlecorn.md): Run untrusted Elixir and Erlang code on the server inside a WebAssembly sandbox.
- [Kettlecorn.Cook](Kettlecorn.Cook.md): Packages a compiled Mix application and its dependencies for the guest.
- [Kettlecorn.ETF](Kettlecorn.ETF.md): A strict decoder for terms produced by the (untrusted) guest VM.
- [Kettlecorn.Install](Kettlecorn.Install.md): Installs the native runtime for this platform from a GitHub release.
- [Kettlecorn.Opaque](Kettlecorn.Opaque.md): A guest reference or port. Carries no usable data on the host.
- [Kettlecorn.Pid](Kettlecorn.Pid.md): A process inside a guest VM.
- [Kettlecorn.Runtime](Kettlecorn.Runtime.md): Finds a platform runtime containing the native launcher, WebAssembly
emulators and guest file system.
- [Kettlecorn.Runtime.Manifest](Kettlecorn.Runtime.Manifest.md): A runtime's `manifest.json`, as `Kettlecorn.Runtime.load/1` reads it for
a runtime with this library's protocol version.
- [Kettlecorn.Sandbox](Kettlecorn.Sandbox.md): Validated VM options: limits, grants, guest code and runtime.
`Kettlecorn.Sandbox.Instance` creates the VM's private directory and its
launcher command line.
- [Kettlecorn.Sandbox.Instance](Kettlecorn.Sandbox.Instance.md): One VM's private directory, and the launcher command line that runs the
VM on it.
- [Kettlecorn.Struct](Kettlecorn.Struct.md): A guest struct represented as data: its module and fields.
- [Kettlecorn.VM](Kettlecorn.VM.md): One sandboxed BEAM instance running in Wasmtime.

## Mix Tasks

- [mix kettlecorn.cook](Mix.Tasks.Kettlecorn.Cook.md): Compiles the current project and packages it, with its dependencies, for
the guest (see `Kettlecorn.Cook`).
- [mix kettlecorn.eval](Mix.Tasks.Kettlecorn.Eval.md): Evaluates Elixir code, or Erlang with `--erlang`, in a fresh sandboxed VM
and prints the result.
- [mix kettlecorn.install](Mix.Tasks.Kettlecorn.Install.md): Downloads and verifies the platform-specific runtime for this library version,
including its native launcher. Python and a separate Wasmtime installation
are not required.
- [mix kettlecorn.run](Mix.Tasks.Kettlecorn.Run.md): Runs the installed runtime's `kettlecorn-run` with the supplied arguments.

