# `mix bb_liveview.install`
[🔗](https://github.com/beam-bots/bb_liveview/blob/main/lib/mix/tasks/bb_liveview.install.ex#L6)

Installs BB.LiveView dashboard into a Phoenix project

Imports the package's formatter rules and mounts the BB dashboard inside
your Phoenix router.

If the project has no Phoenix router yet, the installer composes the
minimal set of `phx_install` sub-tasks needed to support a LiveView
dashboard — `phx.install.core`, `phx.install.endpoint`,
`phx.install.router`, `phx.install.live`, `phx.install.assets`. It
deliberately skips ecto, mailer, gettext, page, dashboard, heroicons, and
components — robotics projects rarely want them, and `bb_liveview` brings
its own UI assets.

## Example

```bash
mix igniter.install bb_liveview
mix igniter.install bb_liveview --path /robot --robot MyApp.Arm
```

## Options

* `--robot` - The robot module (defaults to `{AppPrefix}.Robot`).
* `--path` - URL path to mount the dashboard at (default `/`).
* `--auto-phoenix` - When Phoenix is missing, install it without prompting.

---

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