# `mix joby_kit.install`
[🔗](https://github.com/jobycorp/joby_kit/blob/v0.2.0/lib/mix/tasks/joby_kit.install.ex#L1)

Installs JobyKit into an existing Phoenix project.

Generates four files under `lib/<your_app>_web/`:

  * `design_manifest.ex` — `use JobyKit.Manifest` declaration with one
    example component registration and a `daisy_overrides/0` callback.
  * `design_previews.ex` — preview functions for the registered
    components (one per component, suffixed `_preview`).
  * `live/design_system_live.ex` — the kit-curated `/design` page.
  * `live/custom_designs_live.ex` — the host-owned `/custom-designs`
    page for composites and domain components.

Existing files are not overwritten unless you pass `--force`. Routes
are not auto-injected; the task prints the lines you need to add to
`router.ex` at the end.

## Usage

    mix joby_kit.install
    mix joby_kit.install --force            # overwrite existing files
    mix joby_kit.install --web MyAppWeb     # specify web module name

## Next steps

After running this task, follow the printed instructions to:

  1. Add the two `live` routes and the JSON `get` route to your
     `router.ex`.
  2. Restart the dev server.
  3. Visit `/design` and `/custom-designs`.

See the `mix joby_kit.bootstrap` task for a more aggressive variant
aimed at fresh `mix phx.new` projects (replaces the default Phoenix
landing page). For a from-scratch app, see `mix joby_kit.new`.

---

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