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

Installs bb_jido into a project

Always composes `bb_jido.add_jido_instance`, which creates a Jido
instance module and wires it into the application supervision tree.

If `--robot` is supplied, also composes `bb_jido.add_agent` to scaffold
an agent module that drives that robot.

## Examples

```bash
mix igniter.install bb_jido
mix igniter.install bb_jido --robot MyApp.Robot
mix igniter.install bb_jido --robot MyApp.Robot --jido-instance MyApp.AgentRuntime
```

## Options

* `--robot` - If given, scaffolds an agent module for this robot.
* `--agent` - The agent module name (passed to `bb_jido.add_agent`).
* `--jido-instance` - The Jido instance module name (passed to
  `bb_jido.add_jido_instance`).

---

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