# README
Hass.io CLI
Description
Commandline interface to facilitate interaction with hass.io server
Usage
hassio help
hassio <subcommand> <action> [<options>]
E.g.:
hassio homeassistant info --rawjson
Modifiers
Global
- --debug,-d -> Enables debug output
SubCommand
- --rawjson,-j -> Will return the data in JSON format on a single line (useful for passing to other programs to parse / utilise)
- --options,-o -> Used to send commands to hass.io
hassio homeassistant update --options version=0.60
- --filter,-f -> Used to filter the data returned from hass.io so only the specified properties are output
Note: Modifer order is important.
hassio <GlobalModifier> <SubCommand> <Action> <SubCommandModifier>
Install
To install, use go get
:
go get -d github.com/home-assistant/hassio-cli
Contribution
- Fork (https://github.com/home-assistant/hassio-cli/fork)
- Create a feature branch
- Commit your changes
- Rebase your local changes against the master branch
- Run test suite with the
go test ./...
command and confirm that it passes - Run
gofmt -s
- Create a new Pull Request
Building
go test ./...
gox -osarch="linux/arm" -ldflags="-s -w" -output="hassio"
upx --brute hassio
# Packages
No description provided by the author
# Functions
CommandNotFound used to display if a user enters a non-existant command.
# Variables
Commands holds the commands that are supported by the CLI.
GlobalFlags Used to hold global flags.