homewizard-cli

README

homewizard-cli

homewizard-cli is a command-line tool to manage HomeWizard devices. It was principally created to validate the implementation of my Go client library.

Usage

Usage: homewizard-cli <command> [flags]

Flags:
  -h, --help             Show context-sensitive help.
      --target=STRING    URL of the device
      --token=STRING     API token

Commands:
  users list
    List users

  users add <user-name> [flags]
    Add user

  users delete <user-name>
    Delete user

  device info
    Show device information

  device hostname
    Show hostname for HTTPS certificate verification

  system info
    Show system information

  system cloud <enable>
    Enable/disable cloud connection

  system apiv1 <enable>
    Enable/disable APIv1

  system led <brightness>
    Set LED brightness

  system identify
    Flash the device's status LED

  system reboot
    Reboot the device

The target is mandatory for all commands. The token is mandatory except for the users add command, which relies on user action (pushing the device's button) for authentication.

target and token can be set as environment variables: HWE_TARGET and HWE_TOKEN respectively.

Acknowledgements

• This module wouldn't be possible without HomeWizard's excellent API documentation and support.

Authors

• Christophe Lambin

License

This project is licensed under the MIT license.