Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpb587/hubitat-cli
An unofficial CLI for some Hubitat commands.
https://github.com/dpb587/hubitat-cli
cli go hubitat
Last synced: about 2 months ago
JSON representation
An unofficial CLI for some Hubitat commands.
- Host: GitHub
- URL: https://github.com/dpb587/hubitat-cli
- Owner: dpb587
- License: mit
- Created: 2022-02-15T06:51:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-09T03:06:47.000Z (over 1 year ago)
- Last Synced: 2024-06-20T15:02:44.520Z (6 months ago)
- Topics: cli, go, hubitat
- Language: Go
- Homepage:
- Size: 61.5 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hubitat-cli
An unofficial CLI for some [Hubitat](https://hubitat.com/) commands.
Hubitat doesn't really have a formal API so this is a little hacky and may break across platform updates. It currently supports a few management commands that I rely on in automation (namely downloading backups and rotating HTTPS certificates). Use at your own risk.
## Usage
Download and install the binary for your Linux, macOS, or Windows environment from the [releases page](https://github.com/dpb587/hubitat-cli/releases). At a minimum, you'll need to configure the IP or hostname of your Hubitat node.
```bash
$ hubitat-cli --hub-url='http://192.0.2.100' ...
```
If your hub requires login ([learn more](https://docs.hubitat.com/index.php?title=Hub_Login_Security)), you will also want to configure your username and password.
```bash
$ hubitat-cli \
--hub-url='http://192.0.2.100' \
--hub-username='janedoe' \
--hub-password='secretpassword' \
...
```
Environment variables may be used for many of the global flags to help with automation or avoid repetitive commands.
```bash
$ export HUBITAT_URL=http://192.0.2.100
$ export HUBITAT_USERNAME='janedoe'
$ export HUBITAT_PASSWORD='secretpassword'
$ hubitat-cli ...
```
Use the `--help` flag at any point to view more details on flags, arguments, and any available subcommands. For example, to download the latest backup you might use the following.
```bash
$ hubitat-cli backup download \
--output=latest.lzf
```
To update server certificates you might use the following.
```bash
$ hubitat-cli advanced certificate update \
--certificate-path=/mnt/config/tls.crt \
--private-key-path=/mnt/config/tls.key
```
To manually reboot the hub (and optionally `--follow` progress until it's back online):
```bash
$ hubitat-cli reboot --follow
```
To check if updates are available:
```bash
$ hubitat-cli cloud check-for-update
```
To immediately apply an update (and optionally `--follow` progress until it's back online):
```bash
$ hubitat-cli cloud update-platform --follow
```
If the CLI is erroring or not behaving as you expect, try enabling logging with the `-v` verbosity flag. If logs are unhelpful or you still have a concern, refer to them when searching and reporting a [project issue](https://github.com/dpb587/hubitat-cli/issues).
### Advanced
If Hubitat has HTTPS enabled, the CLI will reject any certificates your system does not already trust. To trust a custom CA, configure the CA certificate file path with the `--hub-ca-path=` flag (or `HUBITAT_CA_PATH` environment variable). See the `--help` option for additional connection options and methods for disabling secure connections.
A minimal image is available for use from [Docker](https://www.docker.com/), [Kubernetes](https://kubernetes.io/), or any other container runtime. To avoid potentially breaking changes, use a major version tag (e.g. `v0`) rather than the default `latest` tag.
```bash
$ docker run ghcr.io/dpb587/hubitat-cli
```
## License
[MIT License](LICENSE)