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
| verb | what it does |
|---|---|
on | Turn on — --brightness 0-100, --kelvin, --color |
off | Turn off |
toggle | Flip; lamps that were off come back at their profile values |
brightness | Set 0-100, or step with +10 / -10 |
temperature | Colour temperature in Kelvin, clamped to what the lamp can reach |
color | #rrggbb or a name — Hue only, the Key Lights are white |
identify | Blink, so you can tell which lamp it is |
status | Read back what the lamps are doing |
info | What the device says about itself |
watch | Stream changes as they happen |
Commands
| command | what it does |
|---|---|
setup | Scan, check what is usable, and write a config |
discover | Find lamps and bridges over multicast DNS, changing nothing |
pair | Get an application key from a Hue bridge |
pki | Create your own certificate authority (Elgato) |
onboard | Teach a factory-reset Elgato lamp your certificate |
ls | List the lamps and profiles in your config |
config | Show where the config lives and what is in it |
backends, version, help |
Options
| flag | |
|---|---|
--host | Lamp or bridge address, for one-off use without a config |
--type | elgato or hue |
--certs | Certificate directory or path prefix (Elgato) |
--id | Light, room or zone to control (Hue) |
--token | Bridge application key, or a file holding it (Hue) |
--config | Config file to use |
--json | Machine-readable output |
--quiet, -q | Errors 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_CONFIG | Config file to use |
LUME_HUE_TOKEN | Hue application key |
LUME_WIFI_PASSWORD | Wi-Fi password for onboarding |
NO_COLOR | Plain 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.