# `mix kettlecorn.cook`
[🔗](https://github.com/mjrusso/kettlecorn/blob/v0.1.0/host/lib/mix/tasks/kettlecorn.cook.ex#L1)

Compiles the current project and packages it, with its dependencies, for
the guest (see `Kettlecorn.Cook`).

Cooking runs project code, dependencies, compiler hooks, and configuration on
the host with the build user's permissions. Cook trusted projects or isolate
fetching and building separately. The guest sandbox applies when the bundle runs.

    MIX_ENV=prod mix kettlecorn.cook
    mix kettlecorn.install --dir .kettlecorn-runtime
    MIX_ENV=prod mix kettlecorn.cook --out _kettlecorn --runtime .kettlecorn-runtime

Add Kettlecorn to the project for the task only:

    {:kettlecorn, "~> 0.1", runtime: false, only: [:dev, :prod]}

Options:

  * `--out` - output path (default `_kettlecorn`). Cooking publishes a symbolic
    link and replaces it after a successful cook. Move an existing ordinary
    directory aside first; see `Kettlecorn.Cook.cook/1` for retained copies.
  * `--app` - entrypoint application (default: the current project's).
  * `--root` - another application to cook with its dependencies (see
    `:roots` in `Kettlecorn.Cook.cook/1`); can be given more than once.
  * `--runtime` - runtime to check the dependencies against (default
    `$KETTLECORN_RUNTIME`, if set).

Compile the project with the runtime's OTP major release and exact Elixir
version, recorded in `manifest.json`. Then run it:

    .kettlecorn-runtime/bin/kettlecorn-run --app _kettlecorn
    .kettlecorn-runtime/bin/kettlecorn-run --app _kettlecorn --iex
    .kettlecorn-runtime/bin/kettlecorn-run --app _kettlecorn script.exs

or from a host program with `Kettlecorn.start_link(app: "_kettlecorn")`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
