Skip to content
ky13Public

About

Read-only live terminal view of a Home Assistant dashboard (Textual)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

4 Commits

Folders and files

Repository files navigation

hatop

Read-only, live terminal view of one Home Assistant dashboard, built with Textual.

It loads the dashboard's cards over the HA websocket API, so editing the dashboard in HA changes the panels (live, via lovelace_updated). One panel per section (sections views) or per card (masonry views). States are worded the way the HA frontend words them (Open/Closed, Dry/Wet, OK/Problem, thermostat temperature and action). Alarm states and unavailable entities are red, active states yellow. A dropped connection dims the panels, says since when in the status line, and retries with backoff up to 30 s. No key fires a service call.

Colors are the terminal's own ANSI palette and background. Icons are HA's Material Design Icons as Nerd Font v3 glyphs, so the terminal needs a Nerd Font (Ghostty has one built in as a fallback). Layout follows the dashboard's max_columns, with panels capped at 60 cells and centered. Thermostats get big digits and a gauge from min to max temperature showing the setpoint band and the current temperature.

Setup

Needs uv (it fetches Python 3.14 if you don't have it) and a Nerd Font in your terminal.

uv tool install git+https://github.com/ky13/hatop

Create a long-lived access token in Home Assistant (your profile, Security tab, Long-lived access tokens). HA tokens always carry the owning user's full permissions; hatop only reads, but put the token somewhere private.

~/.config/hatop/config.toml:

url = "http://homeassistant.local:8123"
dashboard = "my-dashboard"          # the dashboard's url_path; omit for the default dashboard
pass_entry = "path/to/ha-token"     # optional: read the token from pass (first line)

The token comes from HA_TOKEN in the environment if set, otherwise from pass show <pass_entry>.

Keys: r reload, q quit. Mouse support is off.

License

MIT

About

Read-only live terminal view of a Home Assistant dashboard (Textual)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages