Skip to content

Command Reference

Griffen Fargo edited this page May 14, 2026 · 4 revisions

Command Reference

Complete reference for all lightsctl.sh commands.

Basic Usage

./lightsctl.sh <command> [arguments]

All commands can also be run via Makefile shortcuts: make <command>

Core Commands

Command Description
validate Pre-flight validation of config and connectivity
doctor Comprehensive health check with recommendations
health Quick status check (service, web UI, USB, resources)
test-dmx Verify ENTTEC USB and DMX output capability
backup Pull QLC+ config to local storage
restore <file> Restore QLC+ config from backup

Provisioning

Command Description
setup-full Full provisioning: setup then harden (recommended)
setup Base install (requires WIFI1_SSID/PSK)
harden Firewall, watchdog, unattended upgrades
add-key [pubkey] Install SSH public key on Pi
static-ip <ip/prefix> <gw> Configure static IP address
update apt update && upgrade on Pi

Service Management

Command Description
status systemd status for qlcplus-web.service
restart Restart qlcplus-web.service
logs Last 80 lines from service journal
logs-errors Show only ERROR and WARN lines
tail Follow service logs live
diagnose Full diagnostic dump

QLC+ Operations

Command Description
deploy-workspace <file> Upload workspace to Pi and restart
pull-workspace [output] Download current workspace from Pi
list-fixtures Show installed fixture definitions
install-fixture <file> Upload custom fixture definition
open-web Open web UI in default browser

Network & System

Command Description
wifi-status Show current SSID and IP address
scan Scan network for Pi devices
ssh Open interactive shell on Pi
reboot Reboot the Pi
os-version Show OS and kernel version

Clone this wiki locally