mix joby_kit.install (JobyKit v0.3.2)

Copy Markdown View Source

Installs JobyKit into an existing Phoenix project.

Generates five files under lib/<your_app>_web/:

  • design_manifest.ex — use JobyKit.Manifest, with every shipped core wrapper pre-registered and a daisy_overrides/0 callback.
  • design_previews.ex — preview functions for the registered components (one per component, suffixed _preview).
  • components/composite_components.ex — the worked empty_state composite, as a precedent for extending the kit.
  • 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.

It also patches, idempotently: AGENTS.md and CLAUDE.md (the wrapper-contract guidance), assets/css/app.css (a Tailwind @source so kit classes are generated), and your layout's nav.

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, which ships as the separate joby_kit_new archive.