# Home Assistant Bridge

> One shared Home Assistant connection for your machine, served to local apps over a single socket.

## Docs

- [Overview](https://ha-bridge.timmo.dev/): One shared Home Assistant connection for your machine, served to local apps over a single socket.
- [Install](https://ha-bridge.timmo.dev/install): Install Home Assistant Bridge from the timmo pacman repository, a Debian or RPM package, or a release archive.
- [Configuration](https://ha-bridge.timmo.dev/configuration): Point Home Assistant Bridge at your Home Assistant URL and a long-lived access token.
- [Running the bridge](https://ha-bridge.timmo.dev/running): Run Home Assistant Bridge as a systemd user service, read its logs and keep it running.
- [Libraries](https://ha-bridge.timmo.dev/libraries): Use the bridge, or Home Assistant directly, from your own Effect app.
- [Migrating from Go Automate](https://ha-bridge.timmo.dev/from-go-automate): What changes when you move from Go Automate to ha-bridge.

## Using

- [Actions](https://ha-bridge.timmo.dev/using/actions): Control lights, switches, covers, climate entities, input helpers and assist satellites from the command line.
- [Watching entities](https://ha-bridge.timmo.dev/using/watching): Stream Home Assistant entity state into scripts and status bars through the bridge.
- [Shell completions](https://ha-bridge.timmo.dev/using/completions): Tab completion for Home Assistant Bridge commands, aliases and flags in bash, zsh and fish.

## Reference

- [Commands](https://ha-bridge.timmo.dev/reference/commands): Every Home Assistant Bridge command, alias, argument and flag, generated from the CLI's help.
- [Bar JSON](https://ha-bridge.timmo.dev/reference/bar-json): The JSON lines that watchers print for status bars, shells and scripts.
- [Bridge protocol](https://ha-bridge.timmo.dev/reference/protocol): The RPCs the bridge serves on its Unix socket, and their wire format.

## Agent skills

- [home-assistant-bridge](https://ha-bridge.timmo.dev/.well-known/agent-skills/home-assistant-bridge/SKILL.md): Read the Home Assistant Bridge docs instead of answering from memory. One shared Home Assistant connection for your machine, served to local apps over a single socket. Use when a task involves Home Assistant Bridge: how it works, how to set it up or configure it, or its API.

## Agent resources

- [llms-full.txt](https://ha-bridge.timmo.dev/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://ha-bridge.timmo.dev/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://ha-bridge.timmo.dev/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://ha-bridge.timmo.dev/openapi.json.
- [MCP server](https://ha-bridge.timmo.dev/mcp): Streamable HTTP Model Context Protocol server with search_docs, get_page, list_pages, and get_navigation tools, plus every page as a resource. Discovery document: https://ha-bridge.timmo.dev/.well-known/mcp.json
- [Agent skills](https://ha-bridge.timmo.dev/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes.
- [API catalog](https://ha-bridge.timmo.dev/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://ha-bridge.timmo.dev/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://ha-bridge.timmo.dev/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://ha-bridge.timmo.dev/sitemap.xml): Every indexable page URL with its last-modified date.