Getting Started

This guide covers installation into an existing Phoenix application. For a new application, use the mix igniter.new command shown in the README.

Rekindle 0.1 runs on Linux with procfs mounted at /proc. Its managed Cargo processes require setsid, pkill, and kill.

Add Rekindle to an existing Phoenix application

Add Igniter to the application's development dependencies:

def deps do
  [
    {:igniter, "~> 0.8", only: [:dev, :test]}
  ]
end

Fetch the dependency, then install Rekindle:

mix deps.get
mix igniter.install rekindle --integration gpui --targets web,desktop

Valid integrations are gpui, egui, and slint. Valid target selections are web, desktop, and web,desktop. When the flags are omitted for a new client, Rekindle selects GPUI and enables both targets. The Web target is wasm32-unknown-unknown; Rekindle 0.1 qualifies desktop builds on x86_64-unknown-linux-gnu.

The installer adds Rekindle as an application dependency, creates or adopts the Rust client, configures the Phoenix development runtime, and adds Web release building to assets.deploy.

Adopt an existing Rust client

Rekindle does not overwrite an existing client/Cargo.toml. To adopt one, supply the integration and targets explicitly:

mix igniter.install rekindle --integration egui --targets web,desktop

The selected entries must already exist at client/src/bin/web.rs and client/src/bin/desktop.rs. Rekindle validates the Cargo package and selected integration from an isolated copy before changing the project. A lockfile is not required, and validation does not create or update files under client/.

Next steps

Read How Rekindle Works for the generated client layout, then continue with Configuration or Development.