home-assistant-ecosystem / home-assistant-cli Goto Github PK
View Code? Open in Web Editor NEW:computer: Command-line tool for Home Assistant
License: Other
:computer: Command-line tool for Home Assistant
License: Other
hass-cli event listen <event_type>*
which will login and subscribe for each event_type listed and then
for every received event print formatted output. Might want option to add additional filtering.
Would be nice to list/query devices and manipulate areas.
$ hass-cli area list
AREA
Bathroom
Winter Garden
Kitchen
Guest Room
$ hass-cli area create "Small Bathroom"
$ hass-cli area delete "Small Bathroom"
$ hass-cli device list "Kitchen.*"
# make inventory overview
$ hass-cli --no-headers --columns manufacturer,model device list | sort | uniq -c | sort -nr
10 IKEA of Sweden TRADFRI bulb GU10 WS 400lm
8 Philips SML001
7 LUMI lumi.sensor_magnet.aq2
6 Sonos Play:1
6 Philips LTW012
6 Philips LCT003
6 Philips Hue color spot
6 Philips Hue ambiance candle
5 Philips LWG001
# Assign area "Kitchen" to any entity matching "Kitchen Light" filter.
$ hass-cli device assign --filter Kitchen "Kitchen Light"
Not all cases where toggle is wanted.
when running list it would be more useful by default to get a table with columns for each entity rather than json/yaml dump.
same goes for toggle command which in its return values get a list of entities that have been verified to be toggled - just as well show the list of those names rather than raw object dumps.
example:
$ hass-cli entity list
NAME FRIENDLY NAME STATE
sensor.yr sensor for weather on
light.entrance entrance light off
Maybe too early but I cannot run hass-cli on MacOS Sierra
retinabook:home-assistant-cli steffen$ hass-cli
Traceback (most recent call last):
File "/usr/local/bin/hass-cli", line 11, in <module>
load_entry_point('homeassistant-cli', 'console_scripts', 'hass-cli')()
File "/usr/local/lib/python3.5/site-packages/click/core.py", line 716, in __call__
return self.main(*args, **kwargs)
File "/usr/local/lib/python3.5/site-packages/click/core.py", line 675, in main
_verify_python3_env()
File "/usr/local/lib/python3.5/site-packages/click/_unicodefun.py", line 119, in _verify_python3_env
'mitigation steps.' + extra)
RuntimeError: Click will abort further execution because Python 3 was configured to use ASCII as encoding for the environment. Either run this under Python 2 or consult http://click.pocoo.org/python3/ for mitigation steps.
This system lists a couple of UTF-8 supporting locales that
you can pick from. The following suitable locales where
discovered: af_ZA.UTF-8, am_ET.UTF-8, be_BY.UTF-8, bg_BG.UTF-8, ca_ES.UTF-8, cs_CZ.UTF-8, da_DK.UTF-8, de_AT.UTF-8, de_CH.UTF-8, de_DE.UTF-8, el_GR.UTF-8, en_AU.UTF-8, en_CA.UTF-8, en_GB.UTF-8, en_IE.UTF-8, en_NZ.UTF-8, en_US.UTF-8, es_ES.UTF-8, et_EE.UTF-8, eu_ES.UTF-8, fi_FI.UTF-8, fr_BE.UTF-8, fr_CA.UTF-8, fr_CH.UTF-8, fr_FR.UTF-8, he_IL.UTF-8, hr_HR.UTF-8, hu_HU.UTF-8, hy_AM.UTF-8, is_IS.UTF-8, it_CH.UTF-8, it_IT.UTF-8, ja_JP.UTF-8, kk_KZ.UTF-8, ko_KR.UTF-8, lt_LT.UTF-8, nl_BE.UTF-8, nl_NL.UTF-8, no_NO.UTF-8, pl_PL.UTF-8, pt_BR.UTF-8, pt_PT.UTF-8, ro_RO.UTF-8, ru_RU.UTF-8, sk_SK.UTF-8, sl_SI.UTF-8, sr_YU.UTF-8, sv_SE.UTF-8, tr_TR.UTF-8, uk_UA.UTF-8, zh_CN.UTF-8, zh_HK.UTF-8, zh_TW.UTF-8
After installing with pip
, trying to run the source <(hass-cli completion zsh)
command fails:
hass-cli: command not found
I tried to log out and in of SSH, but no luck.
currently you get a menu with a header called unsorted
in zsh completion.
would be nicer if it had the used server name in there.
just need to replace "unsorted" with server name in completion.py
At the moment, hass-cli only supports bash and zsh, fish completions would be very useful.
Reference: http://fishshell.com/docs/current/index.html#completion-own
i just bump into having setup a group that I thought was all great but i noticed it reported state unknown because I made a typo for the ligts.
would be nice to have a lint
command or similar that could check for "dumb" mistakes like this ;)
use datetime parse for a --since
option.
--columns=entity_id,attributes.friendly_name
would be nice and just default column name to the value.
when you have duckdns or similar with certifiactes using your local ip result in errors like:
Traceback (most recent call last):
File "/usr/local/lib/python3.7/site-packages/urllib3/connectionpool.py", line 600, in urlopen
chunked=chunked)
File "/usr/local/lib/python3.7/site-packages/urllib3/connectionpool.py", line 343, in _make_request
self._validate_conn(conn)
File "/usr/local/lib/python3.7/site-packages/urllib3/connectionpool.py", line 849, in _validate_conn
conn.connect()
File "/usr/local/lib/python3.7/site-packages/urllib3/connection.py", line 376, in connect
_match_hostname(cert, self.assert_hostname or hostname)
File "/usr/local/lib/python3.7/site-packages/urllib3/connection.py", line 386, in _match_hostname
match_hostname(cert, asserted_hostname)
File "/usr/local/Cellar/python/3.7.1/Frameworks/Python.framework/Versions/3.7/lib/python3.7/ssl.py", line 327, in match_hostname
% (hostname, dnsnames[0]))
ssl.SSLCertVerificationError: ("hostname 'hassio.local' doesn't match 'andersens.duckdns.org'",)
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/usr/local/lib/python3.7/site-packages/requests/adapters.py", line 449, in send
timeout=timeout
File "/usr/local/lib/python3.7/site-packages/urllib3/connectionpool.py", line 638, in urlopen
_stacktrace=sys.exc_info()[2])
File "/usr/local/lib/python3.7/site-packages/urllib3/util/retry.py", line 398, in increment
raise MaxRetryError(_pool, url, error or ResponseError(cause))
urllib3.exceptions.MaxRetryError: HTTPSConnectionPool(host='hassio.local', port=8123): Max retries exceeded with url: /api/discovery_info (Caused by SSLError(SSLCertVerificationError("hostname 'hassio.local' doesn't match 'yourha.duckdns.org'")))
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/usr/local/bin/hass-cli", line 11, in <module>
load_entry_point('homeassistant-cli', 'console_scripts', 'hass-cli')()
File "/usr/local/lib/python3.7/site-packages/click/core.py", line 764, in __call__
return self.main(*args, **kwargs)
File "/usr/local/lib/python3.7/site-packages/click/core.py", line 717, in main
rv = self.invoke(ctx)
File "/usr/local/lib/python3.7/site-packages/click/core.py", line 1137, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
File "/usr/local/lib/python3.7/site-packages/click/core.py", line 956, in invoke
return ctx.invoke(self.callback, **ctx.params)
File "/usr/local/lib/python3.7/site-packages/click/core.py", line 555, in invoke
return callback(*args, **kwargs)
File "/usr/local/lib/python3.7/site-packages/click/decorators.py", line 64, in new_func
return ctx.invoke(f, obj, *args, **kwargs)
File "/usr/local/lib/python3.7/site-packages/click/core.py", line 555, in invoke
return callback(*args, **kwargs)
File "/Users/max/code/hass-cli/homeassistant_cli/plugins/info.py", line 15, in cli
click.echo(format_output(ctx, req(ctx, "get", "discovery_info")))
File "/Users/max/code/hass-cli/homeassistant_cli/helper.py", line 63, in req
resp = req_raw(ctx, method, endpoint, *args)
File "/Users/max/code/hass-cli/homeassistant_cli/helper.py", line 43, in req_raw
response = requests.get(url, headers=headers, timeout=ctx.timeout)
File "/usr/local/lib/python3.7/site-packages/requests/api.py", line 75, in get
return request('get', url, params=params, **kwargs)
File "/usr/local/lib/python3.7/site-packages/requests/api.py", line 60, in request
return session.request(method=method, url=url, **kwargs)
File "/usr/local/lib/python3.7/site-packages/requests/sessions.py", line 524, in request
resp = self.send(prep, **send_kwargs)
File "/usr/local/lib/python3.7/site-packages/requests/sessions.py", line 637, in send
r = adapter.send(request, **kwargs)
File "/usr/local/lib/python3.7/site-packages/requests/adapters.py", line 514, in send
raise SSLError(e, request=request)
requests.exceptions.SSLError: HTTPSConnectionPool(host='hassio.local', port=8123): Max retries exceeded with url: /api/discovery_info (Caused by SSLError(SSLCertVerificationError("hostname 'hassio.local' doesn't match 'yourha.duckdns.org'")))
would be nice having an option that just warns about the mismatch but will connect.
see https://stackoverflow.com/questions/15445981/how-do-i-disable-the-security-certificate-check-in-python-requests for options.
new apis are added in websockets, not all available via restapi.
Would be good to be able to do things like:
hass-cli device list
that would access device registry in the websockets api
or things like
hass-cli entity watch <...>
would listen on changes for state changes via websockets api
and even more generically:
hass-cli raw ws <method>
would run and wait for result on websockets api.
could even add autocompletion for well known ws endpoints in the latter case.
if no server explicitly or implicitly (hassio) specified then use netdisco to find homeassistant.
need to find a way to run the discovery in a dedicated way.
Does hass-cli require that HTTPS access be enabled in order to work. Is is possible to use without HTTPS enabled on HA?
Does hass-cli only work with hass.io based HA, or will it work with docker image file of HA?
Thx.
An uptime command would be cool
hass-cli, version 0.4.4
Trying to locate Home Assistant on local network...
Exception occurred:
Traceback (most recent call last):
File "/usr/local/lib/python3.6/site-packages/zeroconf.py", line 1179, in handle_read
data, (addr, port) = socket_.recvfrom(_MAX_MSG_ABSOLUTE)
OSError: [Errno 9] Bad file descriptor
Found and using http://192.168.1.4:8123 as server
DIRECTORY
/config/www
zeroconf (0.21.3)
hass-cli entity list | pbcopy
or any other pipe destination result in some weird result.
For some reason output are not properly piped.
currently a request is made for every entity listed on entity toggle|turn_on|turn_off
- should just pass list to entity_id in the json body.
if your server is running with duckdns or similar you will get a certificate error if trying to connect directly via the IP - even if accepting all certificates which is what --insecure
does.
There might be a way to work around this in ssl/requests layer but requires some explicit install of additional dependencies - see https://github.com/urllib3/urllib3/blob/master/src/urllib3/packages/ssl_match_hostname/_implementation.py for details.
import ssl
ssl.match_hostname = lambda cert, hostname: True
should be enough if ipaddress and ssl are installed (which depends on python version)
Got caught in last release with dependencies being quirky so tests and installs ran perfectly but actually running from command line failed due to bad dependencies.
Way to avoid this would be to have a test step that runs pip (or maybe tox?) in a clean environment and then do some basic assertions of cli runs - possibly using https://github.com/bats-core/bats-core
After upgrading to 0.2.0, the CLI doesn't work anymore (changes in #23, #26).
Hass.io Supervisor shows this log:
18-12-11 21:20:57 WARNING (MainThread) [hassio.api.security] No API token provided for /api/config
The weird thing is though, hass-cli info
does not fail (just an empty result):
For the record, I do not have HASS_SERVER
or HASS_TOKEN
env variables set. Just a (valid) HASSIO_TOKEN
.
currently we have commands like:
get (state|event|service)
edit (state|event)
delete (state)
toggle (entity)
completion (zsh|bash)
etc.
I did the get/edit/delete initially since I thought there would be more things to edit but as things are now we end up with other commands that does not follow the same structure so i'm more inclined to move to
something like:
so something more like following <thing> <operation> <target>
pattern instead.
https://kubernetes.io/docs/reference/kubectl/overview/#custom-columns where there are shortcuts like -o=name, -o=wide and -o=columns=, etc.
For Hass.io users the CLI is harder to get running. With a little bit of code, this CLI would probably just work out of the box for these users.
Steps to take:
HASS_SERVER
environment variable is absent.HASS_TOKEN
environment variable is absent.HASSIO_TOKEN
environment variable is present.http://hassio/homeassistant
as the server URLHASSIO_TOKEN
environment variable as the bearer token.if server is on hassio we could expose addon commands
hassio addon open <addon name>
to open webui
hassio addon restart <addon name>
to restart etc.
also hassio system commands could be made.
hassio system restart
hassio ha restart
...
instead of absolute massive timestamps consider having "human" relative dates in output.
expose commands to do the typical 'system' level commands.
config check
reload core
reload groups
reload automations
reload all
?
server restart
server shutdown
Version used: 0.4.4
Problem:
The --columns parameter is not applied to the entity get
command only for entity list
.
I try to create an i3 status bar entry for delaying trains and only need the state value, therefore tried to filter by columns but it didn't work.
Additionally it would be nice to have this as a direct option (e.g. -q
for quiet output with only the state).
Otherwise, great tool, using it already with rofi to quickly toggle the lights in my flat ;).
those using HA requiring client side certificates should have a way to run.
curl uses --key for the key and --cert for the certificate. i.e.
curl -v \
--cacert ./ca.pem \
--key ./admin-key.pem \
--cert ./admin.pem \
https://xxxx/api/v1/
requests supports all three as documented at http://docs.python-requests.org/en/master/user/advanced/
idea from this thread: https://www.reddit.com/r/homeassistant/comments/a56qwa/hasscli_new_command_line_tool_for_home_assistant/eblbjjy/?context=3
hass under https port 8123 and cannot access
any chance to support?
Tried running the source <(hass-cli completion zsh)
returns the following error:
pi@hassbian:~ $ source <(hass-cli completion zsh)
-bash: /dev/fd/63: line 10: syntax error near unexpected token `descr'
-bash: /dev/fd/63: line 10: ` for key descr in ${(kv)response}; do'
I had to install hass-cli with sudo in order to make it install. I tried to run the source command with sudo, but that returns command not found.
currently we depend on homeassistant itself - mainly just to get/share a few constants.
This means a user need to install homeassistant's own dependencies too even though they don't need.
would be nice to avoid that + might be easier to handle mulitple version differences if no hard dep to homeassistant.
hass-cli entity list light.*
hass-cli entity list *battery*
etc.
is it recommended to run in the hass virtual environment or its own?
Thanks.
Would it be possible to add support for brew? It makes it much easier to install / maintain.
can be hard to ask users to setup full dev env to try out a pr.
travis for security reasons don't allow upload or any operations requiring use of encoded keys.
idea is to use transfer.sh to upload the generated wheel and then post ocmment back to pull-request with command for installing the built wheel. transfer.sh deletes it automatically after 14 days which should be sufficient for most PR work.
something always goes wrong or I forget something during release - would be so much nicer if just tagging master would ensure release happens at least for pypi without need for human intervention.
it breaks easily now and no test covers it.
would be nice hass-cli edit entity <entityname> --attributes=friendly_name=Peace
and hass-cli service call homeassistant.toggle <entityname>
would be able to always open editor of the sent command before submitting it.
Maybe add a --editor
flag to enforce it and not just when no attributes/states are given ?
atm. service/event output a nested set of lists; would make more sense to list explicit the individual services and events.
would be nice to have a way to control the table format and columns.
kubectl have --no-headers and column-format options. Should look into supporting something similar.
edit
get
toggle
and when they are gone helper.py can be reduced significantly.
with #79 it is more useful than ever to be able to sorty by i.e. CHANGED column.
something like --sort-by <jsonpath>
using same notion as done for columns; then do the sorting BEFORE making the table data.
hass-cli template run mytemplate.j2
output would be result of running home assistant template function.
hass-cli template run-local mytemplate.j2 mytemplate.data.yaml
output would be result of running templates local with access to things like state, device registry etc. some of which are not currently available in remote home assistant.
Would be nice if homeassistant could receive custom data, but at the moment that is not there which makes it interesting to run templates locally.
Since black can't run on 3.5 let's add seperate step.
to add tests and generally just ease of code reading/updates it would be good if instead of all commands directly interact with the requests api directly that instead it would have a ha
interface/class like the former remote
api.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.