Lux is a command-line interface for controlling and monitoring Govee lighting strips built in Go.

Overview

What is Lux?

Lux is a command-line interface for controlling and monitoring Govee lighting strips built in Go. Lux provides it's users with the ability to manage their lighting strips from their desktop computer from any network with an internet connection.

Installation

Currently, to install Lux, you must download the source and compile it your self. After releases are made, we will provide & host various executables.

Commands

  • lux devices

    Lists the devices registered on the user's account

  • lux query 0

    Returns data about the state of a device

  • lux turn 0 on

    Turn a device on or off

  • lux brightness 0 100

    Alter the brightness of a device

  • lux color 0 #0067f4

    Alter the color of a device

  • lux help

    Lists a list of commands and information about the CLI

Contributing

Looking to contribute to Lux? That's great! There are a couple of ways to help out. Translations, bug reports and pull requests are all greatly appreciated. Please refer to our contributing guidelines to get started.

License

Lux
Copyright © 2021 BanDev

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/

Issues
  • No default help page

    No default help page

    Default help that contains a list of commands should be provided for requests with no args or requests with help args.

    documentation enhancement 
    opened by jackdevey 1
  • Add method to manage colours, brightness & power state

    Add method to manage colours, brightness & power state

    Should provide a method for controlling devices through the cli.

    enhancement 
    opened by jackdevey 0
  • Add help command

    Add help command

    Fix #1

    opened by jackdevey 0
  • Add write functions

    Add write functions

    Closes #2

    enhancement 
    opened by jackdevey 0
  • Add setup command

    Add setup command

    Add setup command

    Provides the user with a better way to access their Govee account through lux.

    Merge Checklist

    • [x] Follows lux design guidelines (Github Primer)
    • [ ] API Key is stored
    • [ ] API Key is checked before storage
    • [ ] Shows a warning when a user is already authenticated
    • [ ] Key setup tutorial page live
    • [ ] Command has been added to bandev.uk api

    Design

    Implements major design queues from Github Cli Guidelines & AlecAivazis/survey

    The user is asked if they have an API Key

    image

    If they have one, they are prompted to enter it

    image

    Otherwise, they are prompted to follow a tutorial detailing how to create one

    image

    Checklist enhancement 
    opened by jackdevey 0
  • v1.0.0 Release checklist

    v1.0.0 Release checklist

    • [x] All intended read functions working
    • [x] All intended write functions working
    • [x] Help & home pages working
    • [x] All outputs follow design guidelines
    • [x] All error messages working as intended
    • [ ] User can add their Govee API Key [#7]
    Checklist 
    opened by jackdevey 0
Releases(v1.0.0-Beta1)
Owner
BanDev
BanDev is a collaborative group of developers. We create apps that are entirely Free, Libre and Open Source.
BanDev
Simplistic interactive filtering tool

peco Simplistic interactive filtering tool NOTE: If you are viewing this on GitHub, this document refers to the state of peco in whatever current bran

null 6.4k Jun 15, 2021
A versatile library for building CLI applications in Go

mow.cli Package cli provides a framework to build command line applications in Go with most of the burden of arguments parsing and validation placed o

Jawher Moussa 739 Jun 14, 2021
pgCenter is a command-line admin tool for observing and troubleshooting Postgres.

Command-line admin tool for observing and troubleshooting Postgres.

Lesovsky Alexey 1.2k Jun 10, 2021
Kong is a command-line parser for Go

Kong is a command-line parser for Go Introduction Help Help as a user of a Kong application Defining help in Kong Command handling Switch on the comma

Alec Thomas 553 Jun 13, 2021
A modern UNIX ed (line editor) clone written in Go

ed (the awesome UNIX line editor) ed is a clone of the UNIX command-line tool by the same name ed a line editor that was nortorious for being and most

James Mills 45 May 29, 2021
A Commander for modern Go CLI interactions

Cobra is both a library for creating powerful modern CLI applications as well as a program to generate applications and command files. Cobra is used i

Steve Francia 21.9k Jun 13, 2021
Fully featured Go (golang) command line option parser with built-in auto-completion support.

go-getoptions Go option parser inspired on the flexibility of Perl’s GetOpt::Long. Table of Contents Quick overview Examples Simple script Program wit

David Gamba 35 Jun 8, 2021
:cherry_blossom: A command-line fuzzy finder

fzf is a general-purpose command-line fuzzy finder. It's an interactive Unix filter for command-line that can be used with any list; files, command hi

Junegunn Choi 37.2k Jun 13, 2021
A simple way of sending messages from the CLI output to your Discord channel with webhook.

discat A simple way of sending messages from the CLI output to your Discord channel with webhook. Actually, this is a fork version of slackcat that I

dw1 21 May 15, 2021
CONTRIBUTIONS ONLY: A Go (golang) command line and flag parser

CONTRIBUTIONS ONLY What does this mean? I do not have time to fix issues myself. The only way fixes or new features will be added is by people submitt

Alec Thomas 3.1k Jun 10, 2021
Tool for shell commands execution, visualization and alerting. Configured with a simple YAML file.

Sampler. Visualization for any shell command. Sampler is a tool for shell commands execution, visualization and alerting. Configured with a simple YAM

Alexander Lukyanchikov 8.9k Jun 14, 2021
Another CLI framework for Go. It works on my machine.

Command line interface framework Go framework for rapid command line application development

Ulrich Kautz 108 May 24, 2021
CLI - A package for building command line app with go

Command line interface Screenshot Key features Lightweight and easy to use. Defines flag by tag, e.g. flag name(short or/and long), description, defau

王仕晋 578 Jun 11, 2021
Sloc, Cloc and Code: scc is a very fast accurate code counter with complexity calculations and COCOMO estimates written in pure Go

Sloc Cloc and Code (scc) A tool similar to cloc, sloccount and tokei. For counting physical the lines of code, blank lines, comment lines, and physica

Ben Boyter 2.5k Jun 16, 2021