{"id":19286820,"url":"https://github.com/openhue/openhue-cli","last_synced_at":"2025-04-22T03:33:43.425Z","repository":{"id":202901062,"uuid":"708384181","full_name":"openhue/openhue-cli","owner":"openhue","description":"OpenHue CLI is a command-line interface for interacting with Philips Hue smart lighting systems. ","archived":false,"fork":false,"pushed_at":"2025-03-27T08:09:32.000Z","size":1213,"stargazers_count":54,"open_issues_count":2,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-27T09:25:16.367Z","etag":null,"topics":["automation","cli","cobra-cli","golang","openhue","philips-hue"],"latest_commit_sha":null,"homepage":"https://www.openhue.io/cli","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openhue.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-22T12:08:37.000Z","updated_at":"2025-03-27T08:08:38.000Z","dependencies_parsed_at":"2024-03-22T09:53:03.611Z","dependency_job_id":"a188211e-ad0e-4ca0-abba-beaf69f7e8e6","html_url":"https://github.com/openhue/openhue-cli","commit_stats":null,"previous_names":["openhue/openhue-cli"],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openhue%2Fopenhue-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openhue%2Fopenhue-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openhue%2Fopenhue-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openhue%2Fopenhue-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openhue","download_url":"https://codeload.github.com/openhue/openhue-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250167614,"owners_count":21386004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","cli","cobra-cli","golang","openhue","philips-hue"],"created_at":"2024-11-09T22:04:27.401Z","updated_at":"2025-04-22T03:33:43.078Z","avatar_url":"https://github.com/openhue.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenHue CLI\n[![Build](https://github.com/openhue/openhue-cli/actions/workflows/build.yml/badge.svg)](https://github.com/openhue/openhue-cli/actions/workflows/build.yml)\n[![CodeQL](https://github.com/openhue/openhue-cli/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/openhue/openhue-cli/actions/workflows/github-code-scanning/codeql)\n[![Maintainability with Code Climate](https://api.codeclimate.com/v1/badges/fb934bb37c36a04f8efd/maintainability)](https://codeclimate.com/github/openhue/openhue-cli/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/fb934bb37c36a04f8efd/test_coverage)](https://codeclimate.com/github/openhue/openhue-cli/test_coverage)\n[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/openhue/cli/latest)](https://hub.docker.com/r/openhue/cli)\n\n## Overview\n\nOpenHue CLI is a command-line interface for interacting with Philips Hue smart lighting systems. \nThis tool provides a convenient way to control your Philips Hue lights and perform various tasks using the command line.\n\n[![How to setup OpenHue CLI](./docs/images/openhue_setup.gif)](https://www.openhue.io/cli/setup)\n\n## Features\n\n- Discover and connect to Philips Hue bridges.\n- List available lights and their status.\n- Control lights: on, off, brightness, and color.\n- Schedule light actions.\n\nFor a complete list of features and usage, \nplease refer to the [OpenHue CLI online documentation](https://www.openhue.io/cli/openhue-cli).\n\n## Getting Started\n\nTo begin developing with Open-Hue's OpenAPI specification, follow these steps:\n\n### Prerequisites\n\nBefore you start, ensure that you have the following prerequisites installed:\n- [Golang](https://go.dev/doc/install) that is used to build and run the project\n- [GoReleaser](https://goreleaser.com) that is used to build and release the binaries. Used behind the scene when running the `make build` command\n- [oapi-codegen](https://github.com/oapi-codegen/oapi-codegen) (_optional_) that is used to generate the client code from the openhue-api specification. Used behind the scene when running the `make generate` command\n- [Docker](https://docs.docker.com/engine/install/) (_optional_) that is used to build the CLI Docker Image and run it as a container\n\n### Fork the Repository\nBefore contributing to OpenHue CLI, it's a good practice to [fork](https://github.com/openhue/openhue-cli/fork) the repository to your own GitHub account.\nThis will create a copy of the project that you can work on independently.\n\n### Build\n\n1. Clone the OpenHue CLI repository to your local machine:\n```shell\ngit clone https://github.com/your-username/openhue-cli.git\ncd openhue-cli\n```\n2. Run the following command to build OpenHue CLI on your local environment:\n```shell\nmake build\n```\n\n### Test\nRun the following command to execute all the tests and calculate the code coverage:\n```shell\nmake test\n```\nIf you want, you can also run the following command to visualize the coverage analysis in your browser: \n```shell\nmake coverage\n```\n\u003e or use `make coverage html=true` to visualize the HTML report in your default web browser\n\n### Generate the OpenHue API Client\nRun the following command to generate the [OpenHue API Client](https://github.com/openhue/openhue-api): \n```shell\nmake generate\n```\nIf there was any OpenAPI specification change, this command will update \nthe [`./openhue/gen/openhue.openhue.go`](./openhue/gen/openhue.openhue.go) file. \nPlease note that this file must never be manually edited!\n\nYou also generate the client from another spec location:\n```\nmake generate spec=/path/to/local/openhue.yaml\n```\n\n## License\n[![GitHub License](https://img.shields.io/github/license/openhue/openhue-cli)](https://github.com/openhue/openhue-cli/blob/main/LICENSE)\n\nOpen-Hue is distributed under the [Apache License 2.0](http://www.apache.org/licenses/),\nmaking it open and free for anyone to use and contribute to.\nSee the [license](./LICENSE) file for detailed terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenhue%2Fopenhue-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenhue%2Fopenhue-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenhue%2Fopenhue-cli/lists"}