keylight 0.2.0

A CLI to control an Elgato Key Light

keylight

A modern CLI to control Elgato Key Lights across Linux, macOS, and Windows.

Built with Typer and powered by the pyleglight library.

Requirements

• Python ~3.12

Installation

Install keylight via pip or pipx (recommended for CLIs):

pipx install keylight

Usage

Usage: keylight [OPTIONS]

Options:
  -b, --brightness TEXT       0 <= BRIGHTNESS <= 100; Prefix with +/- to increment/decrement
  -c, --color TEXT            2900 <= COLOR <= 7000; Prefix with +/- to increment/decrement
  --host TEXT                 hostname of the Key Light (omit to use auto-discovery)
  -p, --power [on|off|toggle] turn the Key Light on, off, or toggle it
  --help                      Show this message and exit.

Examples

Auto-discovery and basic control:

$ keylight --brightness 45 --color 5500 --power on
Connected to "Elgato Key Light" at 192.168.1.100:9123
Brightness: 45%
Color temperature: 5500k
On/Off: On

Direct host connection and relative adjustments:

$ keylight --host 192.168.1.105 --brightness +10
Connected to "Elgato Key Light Air" at 192.168.1.105:9123
Brightness: 55%
Color temperature: 5500k
On/Off: On

Toggling power:

$ keylight --power toggle
Connected to "Elgato Key Light" at 192.168.1.100:9123
Brightness: 55%
Color temperature: 5500k
On/Off: Off

Shell Aliases

For quicker access, you can define shell aliases in your .bashrc or .zshrc:

alias kon='keylight --power on'
alias koff='keylight --power off'
alias ktoggle='keylight --power toggle'

Development

keylight uses Poetry for dependency management and packaging.

# Enter the virtual environment
poetry shell

# Run the CLI during development
poetry run keylight --help

# Lint and format
poetry run ruff check .

# Build and publish
poetry build
poetry publish