CLI reference

lightmime [--config <path>] <command>

--config works with every command and defaults to ~/.config/lightmime/config.toml (see Configuration). With the Flatpak, run commands as flatpak run io.github.pataar.lightmime <command>; without a command, that opens the window. RUST_LOG sets the log level, for example RUST_LOG=debug.

lightmime gui

Open the window and tray icon. Runs the Home Assistant bridge too when MQTT is enabled.

When lightmime is already running, this opens that one’s window (and starts syncing with --start) instead of starting a second copy. Not available in a build without the gui feature.

lightmime run

Sync without a window, controlled over MQTT when that is enabled. Stops on Ctrl-C or SIGTERM.

Exits with an error when lightmime is already running.

lightmime pair --host <address>

Pair with the bridge at <address>. Press the bridge’s link button within a minute.

lightmime import-lumux

Copy the bridge address, keys and entertainment area from Lumux’s settings. See Reusing Lumux’s pairing.

lightmime areas

List the bridge’s entertainment areas: id, name, number of lights and whether an app is streaming to it. * marks the area lightmime uses.

lightmime use-area <area>

Sync to <area>, given by id or by name (case-insensitive).

lightmime test

Run a colour sweep over the area’s lights without capturing the screen, to check the connection.

Controlling a running lightmime

These talk to the lightmime that is running, as lightmime gui or lightmime run, over the session bus. They need no config file and fail with an error when lightmime is not running. They are meant for keybindings and status bars; see Hyprland and Omarchy for examples and the D-Bus interface behind them.