Getting Started

Getting Lux setup on your computer & integrated with your Govee account is simple! You just need to follow these steps:

Installing Lux

You can install Lux however you wish, we provide a simple installer executable for each release but if that's not your style you can easily compile Lux yourself directly from source.

You can attain the latest copy of the Lux installer from our releases page on GitHub, or through Winget using the command below:

winget install BanDev.Lux

If you chose to self compile, you need to ensure you add the program's lux.exe path to your Path environment variables in order for Lux to be detected as a command in PowerShell & CMD.

If using a terminal, restart it to update environment variables and then run the following to begin setting up your instance of Lux.

lux setup

Setting Up Lux

Once Lux is all installed, you will need to provide it a Govee API key so you can link the program to your Govee account. If you already have one, thats great! Select yes and enter it after. Lux will automatically check the key's validity so you will instantly know if you made a typo.

However, if you don't already have one, don't worry because creating one is easy! When inside the official Govee app, navigate to My Profile -> About Us -> Apply for API Key. They usually arrive quite fast, however you may need to wait a couple of days before it arrives in your email account's inbox.

The API key provides direct access to your account, so once you obtain one, you must keep it safe. Don't share it with anyone else or enter it into any websites.

What's Next?

Hopefully everything is working now! You can quickly check to ensure all of your WiFi enabled Govee devices appear correctly by running:

lux devices 

We provide a full updated list of all commands in the repositories readme, so check there for cool commands to try out now!