Command-line tool for Home Assistant.
Project description
The Home Assistant Command-line interface (hass-cli) allows one to work with a local or a remote Home Assistant instance directly from the command-line.
Examples:
Get state of a entity:
$ hass-cli get state sensor
hass-cli get state light.guestroom_light ◼
{
"attributes": {
"friendly_name": "Guestroom Light",
"is_deconz_group": false,
"supported_features": 61
},
"context": {
"id": "e257a0f15fe74579b4a693de65ed618b",
"user_id": "4c7c32b2934f4deeb346bf8017e2bf28"
},
"entity_id": "light.guestroom_light",
"last_changed": "2018-11-18T21:48:20.279802+00:00",
"last_updated": "2018-11-18T21:48:20.279802+00:00",
"state": "off"
}If you prefer yaml you can do:
$ hass-cli -o yaml get state light.guestroom_light
attributes:
friendly_name: Guestroom Light
is_deconz_group: false
supported_features: 61
context:
id: e257a0f15fe74579b4a693de65ed618b
user_id: 4c7c32b2934f4deeb346bf8017e2bf28
entity_id: light.guestroom_light
last_changed: '2018-11-18T21:48:20.279802+00:00'
last_updated: '2018-11-18T21:48:20.279802+00:00'
state: 'off'You can edit state via an editor:
$ hass-cli edit state light.guestroom_lightThis will open the current state in your favorite editor and any changes you save will be used for an update.
You can also explicitly create/edit via the –json flag:
$ hass-cli edit state sensor.test --json='{ "state":"off"}'Auto-completion
For zsh:
eval "$(_HASS_CLI_COMPLETE=source_zsh hass-cli)"For bash:
eval "$(_FOO_BAR_COMPLETE=source foo-bar)"Once enable there is autocompletion for commands and for certain attributes like entities:
$ hass-cli get state light.<TAB> ⏎ ✱ ◼
light.kitchen_light_5 light.office_light light.basement_light_4 light.basement_light_9 light.dinner_table_light_4 light.winter_garden_light_2 light.kitchen_light_2
light.kitchen_table_light_1 light.hallroom_light_2 light.basement_light_5 light.basement_light_10 light.dinner_table_wall_light light.winter_garden_light_4 light.kitchen_table_light_2
light.kitchen_light_1 light.hallroom_light_1 light.basement_light_6 light.small_bathroom_light light.dinner_table_light_5 light.winter_garden_light_3 light.kitchen_light_4
light.kitchen_light_6 light.basement_light_1 light.basement_light_7 light.dinner_table_light_1 light.dinner_table_light_6 light.hallroom_light_4
light.guestroom_light light.basement_light_stairs light.basement_light_2 light.hallroom_light_5 light.dinner_table_light_3 light.winter_garden_light_5
light.hallroom_light_3 light.basement_light_3 light.basement_light_8 light.dinner_table_light_2 light.winter_garden_light_1 light.kitchen_light_3Note: For this to work you’ll need to have setup the following environment variables if your home-assistant is secured and not running on localhost:8123:
export HASS_SERVER=https://hassio.local:8123
export HASS_TOKEN=<Bearer token from HASS_SERVER/profile>help
Usage: hass-cli [OPTIONS] COMMAND [ARGS]...
A command line interface for Home Assistant.
Options:
--version Show the version and exit.
-s, --server TEXT The server URL of Home Assistant instance.
[default: http://localhost:8123]
--token TEXT The Bearer token for Home Assistant instance.
--timeout INTEGER Timeout for network operations.
-o, --output [json|yaml] Output format [default: json]
-v, --verbose Enables verbose mode.
--debug Enables debug mode.
--help Show this message and exit.
Commands:
completion Output shell completion code for the specified shell (bash or...
config Get configuration from Home Assistant.
delete Delete entities.
discover Discovery for the local network.
edit Edit entities.
get List info from Home Assistant.
info Get basic info from Home Assistant.
map Print the current location on a map.
raw Call the raw API (advanced).
toggle Toggle data from Home Assistant.Clone the git repository and
$ pip3 install --editable .Development
Developing is (re)using as much as possible from homeassistant development setup <https://developers.home-assistant.io/docs/en/development_environment.html>.
Recommended way to develop is to use virtual environment to ensure isolation from rest of your system using the following steps:
$ python3 -m venv .
$ source bin/activate
$ script/setupafter this you should be able to edit the source code and running hass-cli directly:
$ hass-cliRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file homeassistant-cli-0.0.2.tar.gz.
File metadata
- Download URL: homeassistant-cli-0.0.2.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c36401b94fff473c7278103d890b93cd359e70ddd2c62829530f5a5046a77e96 |
|
| MD5 | 5537b7bf560475a70eb994824fddf7c2 |
|
| BLAKE2b-256 | a5a80980d146067f62c24251a5e8df805dcbf79803abc7d73d0d2b275617ab86 |
