Installation

Rulestead ships as two sibling packages:

• rulestead for runtime evaluation, installer support, context helpers, and tests
• rulestead_admin for the optional mounted admin UI

Repo GA shipped in v1.0.0 on 2026-05-21, and the current installable package line remains 0.1.0. Install only the package boundary your app needs.

Runtime-only apps

Choose this path if application code needs flag evaluation but your team does not need the mounted admin UI in the host Phoenix app.

defp deps do
  [
    {:rulestead, "~> 0.1"}
  ]
end

Apps that also mount the admin UI

Choose this path if a host Phoenix app needs both runtime evaluation and the operator UI.

defp deps do
  [
    {:rulestead, "~> 0.1"},
    {:rulestead_admin, "~> 0.1"}
  ]
end

Install and migrate

After adding the dependency set you need:

mix deps.get
mix rulestead.install
mix ecto.migrate

mix rulestead.install adds the package-owned setup needed for the runtime surface. If you mount rulestead_admin, follow the router seam documented in rulestead_admin/README.md.

What happens next

• Phoenix integrators: Phoenix Integration Spine — supervision → config → Plug → first flag (lifecycle fields required)
• Lifecycle at create: flags require owner_ref and expected_expiration before save — see Flag Lifecycle
• Follow Getting Started for the first-success path
• Use Evaluation for runtime usage patterns
• Use Admin UI if your app mounts the operator surface
• Use ../../examples/demo/README.md when you want the bounded runnable demo proof path