https://github.com/bmedicke/bhdr

beauftiful home assistant TUI 👁️🐙
https://github.com/bmedicke/bhdr

cli command-line go golang home-assistant tui unittest websocket

Last synced: 2 months ago
JSON representation

beauftiful home assistant TUI 👁️🐙

• Host: GitHub
• URL: https://github.com/bmedicke/bhdr
• Owner: bmedicke
• Created: 2022-04-23T18:36:14.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-05T07:56:49.000Z (about 2 years ago)
• Last Synced: 2024-02-05T05:54:27.018Z (5 months ago)
• Topics: cli, command-line, go, golang, home-assistant, tui, unittest, websocket
• Language: Go
• Homepage:
• Size: 112 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Lists

• awesome-stars - bmedicke/bhdr - beauftiful home assistant TUI 👁️🐙 (Go)

README

        
# BHDR

BHDR is terminal user interface for Home Assistant.

* VI based keybindings

* customizable by editing JSON

* uses the Home Assistant WebSocket API for the fastest possible response time

* includes a WebSocket log-view for easy troubleshooting

*It's like editing your home with Vim!*

## toc

* [installation](#installation)

* [configuration](#configuration)

* [usage](#usage)

* [key bindings](#key-bindings)

## installation

```sh

go install github.com/bmedicke/bhdr@latest

```

## configuration

* edit `.bhdr.json` in your home folder

* if you don't have one bhdr will create one with `bhdr --create-config`

  * see [.bhdr.json](https://github.com/bmedicke/bhdr/blob/main/.bhdr.json) for the template

* `"scheme"` the connection protcol, this should be `ws`

* `"server"` point it to your Home Assistance instance

* `"token"` your Home Assistant long-lived access token

  * to get a token go to your Home Assistant profile ([link for locally running server](http://localhost:8123/profile)) and click **create token**

* `"ha-entities"` array of maps for Home Assistant entities

* `"chordmap"` representation of the Vi grammar

## usage

The following flags are available:

* `--config ` load custom configuration

* `--create-config` creates a template config in your home folder

* `--show-logs` adds a logs view that outputs websocket messages

## key bindings

* all views

  * `q` quit

  * `k` move up

  * `j` move down

  * `ctrl-f` move down a page

  * `ctrl-b` move up a page

  * `g` move to top

  * `G` move to bottom

  * `]` activate *logs* view

  * `[` activate *switches* view

* *switches* view

  * `h` collapse node, move up tree

  * `H` collapse all nodes

  * `l` expand node

  * `L` expand all nodes

  * `;` toggle entity (light, input_boolean, switch, etc.)

* *logs* view

  * `d` clear the log

  * `w` write log to `bhdr_log.json`