lume

Reference

Every verb and command, and the shorthands that save typing.

lume <profile> <verb> [options]    act on one or more lamps
lume <command> [options]           set things up

Verbs

verbwhat it does
onTurn on — --brightness 0-100, --kelvin, --color
offTurn off
toggleFlip; lamps that were off come back at their profile values
brightnessSet 0-100, or step with +10 / -10
temperatureColour temperature in Kelvin, clamped to what the lamp can reach
color#rrggbb or a name — Hue only, the Key Lights are white
identifyBlink, so you can tell which lamp it is
statusRead back what the lamps are doing
infoWhat the device says about itself
watchStream changes as they happen

Commands

commandwhat it does
setupScan, check what is usable, and write a config
discoverFind lamps and bridges over multicast DNS, changing nothing
pairGet an application key from a Hue bridge
pkiCreate your own certificate authority (Elgato)
onboardTeach a factory-reset Elgato lamp your certificate
lsList the lamps and profiles in your config
configShow where the config lives and what is in it
backends, version, help

Options

flag
--hostLamp or bridge address, for one-off use without a config
--typeelgato or hue
--certsCertificate directory or path prefix (Elgato)
--idLight, room or zone to control (Hue)
--tokenBridge application key, or a file holding it (Hue)
--configConfig file to use
--jsonMachine-readable output
--quiet, -qErrors only

Shorthands

lume key on 80 4500 is the same as the two long flags — brightness, then Kelvin. Several lamps at once with lume key,rim off. And lume on key works if that is the order your fingers reach for.

Everything works without a config file at all:

lume --host 192.168.1.29 --certs ~/.config/lume on -b 60
lume --host 192.168.1.53 --id "Hue go 1" color blue

Environment

variable
LUME_CONFIGConfig file to use
LUME_HUE_TOKENHue application key
LUME_WIFI_PASSWORDWi-Fi password for onboarding
NO_COLORPlain output

Colour names

lume <profile> color <name> accepts #rrggbb, #rgb, or one of: red, orange, amber, yellow, green, mint, cyan, blue, indigo, purple, magenta, pink, white.