{"id":13588199,"url":"https://github.com/frosit/zsh-plugin-homeassistant-cli","last_synced_at":"2026-05-08T20:32:01.699Z","repository":{"id":48968241,"uuid":"235253089","full_name":"frosit/zsh-plugin-homeassistant-cli","owner":"frosit","description":"A Oh my ZSH plugin for homeassistant CLI","archived":false,"fork":false,"pushed_at":"2020-06-07T23:43:27.000Z","size":23,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-10T05:38:41.086Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frosit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-21T04:06:12.000Z","updated_at":"2022-12-08T17:55:32.000Z","dependencies_parsed_at":"2022-08-27T19:51:38.244Z","dependency_job_id":null,"html_url":"https://github.com/frosit/zsh-plugin-homeassistant-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/frosit/zsh-plugin-homeassistant-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frosit%2Fzsh-plugin-homeassistant-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frosit%2Fzsh-plugin-homeassistant-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frosit%2Fzsh-plugin-homeassistant-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frosit%2Fzsh-plugin-homeassistant-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frosit","download_url":"https://codeload.github.com/frosit/zsh-plugin-homeassistant-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frosit%2Fzsh-plugin-homeassistant-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32795877,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"ssl_error","status_checked_at":"2026-05-08T08:22:45.650Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T15:06:34.020Z","updated_at":"2026-05-08T20:32:01.681Z","avatar_url":"https://github.com/frosit.png","language":"Shell","funding_links":[],"categories":["Plugins","Shell"],"sub_categories":["ZSH on Windows"],"readme":"# Hass-cli Plugin for Oh-My-Zsh\n\nThis plugin provides completion and (configuration) helpers for the [Home Assistant Command-line interface (hass-cli)](https://github.com/home-assistant/home-assistant-cli). It allows command line interaction with [Home Assistant](https://home-assistant.io/) instances.\n\n# Prerequisites\n\n* [hass-cli](https://github.com/home-assistant/home-assistant-cli#installation)\n* [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh#getting-started)\n\n```bash\ngit clone https://github.com/frosit/zsh-plugin-homeassistant-cli $ZSH_CUSTOM/plugins/hass-cli\n```\n\nTo use, add `hass-cli` to the list of plugins in your `.zshrc` file:\n\n`plugins=(... hass-cli)`\n\n# Configuration\n\n`hass-cli` can autodetect the server url of a local [Home Assistant](https://home-assistant.io/) instance. If this can't be detected you have to specify it together with either a token or password. These can be specified in your session, env vars or on the command line.\n\n```.env\n$HASS_SERVER / --server [server]\n$HASS_TOKEN / --token [token]\n# or\n$HASS_PASSWORD / --password [password]\n```\n\n_supported variables_\n\n```.env\nHASS_SERVER=\"\" (required - server url or \"auto\")\nHASS_TOKEN=\"\" (preffered - Brearer long lasting token)\nHASS_PASSWORD=\"\" (optional - API password)\nHASS_CERT=\"\" (optional - path to client cert.pem)\n```\n_example_\n\n```bash\n# .zshrc\nexport HASS_SERVER=https://hassio.local:8123\nexport HASS_TOKEN=\u003csecret\u003e\n\n# at runtime\nhass-cli --server=https://hassio.local:8123 --token=xxxxxxxxxx \u003carguments\u003e\n```\n\n__Using the wizard (optional)__\n\nRunning `hass-cli_env` will start a wizard that shows the current variables and asks for the missing and writes them to `~/.hass-cli.env`\n\nCurrently the following variables are supported, future branches support all possible variables.\n\n# Additional functions and aliases\n\nBesides easy autocomplete, this plugin was meant to simplify all the options by defining the command arguments in mostly .env files. The aliases are reminders to help you fly a bit more through your terminal.\n\n_aliases_\n\n```\nalias hacli='hass-cli'\nalias hasscli='hass-cli'\nalias hass-cli_check_config='hass-cli service call homeassistant.check_config'\nalias hass-cli_restart='hass-cli service call homeassistant.restart'\nalias hass-cli_states='hass-cli state list'\nalias hass-cli_devices='hass-cli device list'\nalias hass-cli_entities='hass-cli entity list'\nalias hass-cli_syshealth='hass-cli system health'\nalias hass-cli_syslog='hass-cli system log'\n```\n\n_Functions_\n\n* `hass-cli_show_env` : shows currently defined HASS_* env variables.\n* `hass-cli_source_env [file]` : Sources your .hass-cli.env file or the file specified as argument\n* `hass-cli_open` : Open HA in your browser\n* `hass-cli_env` : Shows the current env var or starts the wizard if vars are missing.\n* `_hass-cli_completion`: (re)generate completion\n\n# Advanced configuration\n\nThe [Home Assistant](https://home-assistant.io/) API is poorly documented but has a lot of options that are really useful. Using the advanced configuration you can basically preset options to use in different situations / environments (using .env files). This way you can for example preset additional columns for certain queries and have the output in json so it can easily be parsed with `jq`.\n\nFor now this branch is limited to different .env files. The dev branch supports all the options.\n\n```bash\nexport HASS_DOTENV=$HOME/path/to/my/project/.env\n\n# or \n\nhass-cli_source_env [file]\n```\n\nYou can also just activate the dotenv zsh plugin, works the same, for now.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrosit%2Fzsh-plugin-homeassistant-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrosit%2Fzsh-plugin-homeassistant-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrosit%2Fzsh-plugin-homeassistant-cli/lists"}