CLI

Shade's CLI can provide an API for system tools to control lights, can be run manually, and functions as a sample project for the SDK!

Install

Using HomeBrew

If you're on a Mac with HomeBrew you can install Shade with the following command:


$ brew install inkapplications/cli-tools/shade
            

Manual Install

For Windows or Linux, Shade's CLI can be installed by downloading the latest release and running the or bin/shade.bat or bin/shade executable or adding them to your $PATH.

Connect to a Hue bridge

You can set up your connection to Hue using the connect command. This will automatically discover hue bridges on the network and attempt to authenticate with them.


$ shade connect
Connecting to bridge at 192.168.1.100
Waiting to connect. Press the button on your Hue Device now.
            

List lights

You can get information about of all the lights known to your Hue bridge with the lights:list command.


$ shade lights:list
1:
  name: Renee's Office
  uuid: 00:19:28:37:00:a1:b9:f2-0b
  type: Extended color light
  firmware: 5.127.1.26581
2:
  name: Kitchen
  uuid: 00:91:82:73:00:b9:c3:7a-0b
  type: Extended color light
  firmware: 5.127.1.26581
            

Control Lights

You can control lights using the lights:control command, including on/off, brightness, and color.


$ shade lights:control 1 --on --brightness 50
            

Groups, Scenes, and more

Shade supports commands for many of Hue's API's like Groups and Scenes. For a full list of commands, run shade-cli --help

Contributions and Issues

Shade is free, Open Source, actively maintained, and always looking for contributions.

There are many Hue devices and things to do with them.
Testing all that can be difficult. If you have an issue, please tell us!