Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MaxFmr/openhue-cli

 
 

Repository files navigation

OpenHue CLI

Build CodeQL Maintainability with Code ClimateDocker Image Size (tag) GitHub Repo stars GitHub issues GitHub

Overview

OpenHue CLI is a command-line interface for interacting with Philips Hue smart lighting systems. This tool provides a convenient way to control your Philips Hue lights and perform various tasks using the command line.

Features

  • Discover and connect to Philips Hue bridges.
  • List available lights and their status.
  • Control lights: on, off, brightness, and color.
  • Schedule light actions.

For a complete list of features and usage, please refer to the OpenHue CLI online documentation.

Getting Started

To begin developing with Open-Hue's OpenAPI specification, follow these steps:

Prerequisites

Before you start, ensure that you have the following prerequisites installed:

  • Golang that is used to build and run the project
  • GoReleaser (optional) that is used to build and release the binaries
  • Docker (optional) that is used to build the CLI Docker Image and run it as a container

Fork the Repository

Before contributing to OpenHue CLI, it's a good practice to fork the repository to your own GitHub account. This will create a copy of the project that you can work on independently.

Build

  1. Clone the OpenHue CLI repository to your local machine:
git clone https://github.com/your-username/openhue-cli.git
cd openhue-cli
  1. Run the following command to build OpenHue CLI on your local environment:
make build

Generate the OpenHue API Client

Run the following command to generate the OpenHue API Client:

make generate

If there was any OpenAPI specification change, this command will update the ./openhue/openhue.gen.go file. Please note that this file must never be manually edited!

License

Open-Hue is distributed under the Apache License 2.0, making it open and free for anyone to use and contribute to. See the license file for detailed terms.

About

OpenHue CLI is a command-line interface for interacting with Philips Hue smart lighting systems.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 88.7%
  • Makefile 10.8%
  • Dockerfile 0.5%