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

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

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

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

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

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

Need More Help?

Check out our troubleshooting guide or join the community

All Documentation Join Community