DOCSEARCHbyAlgolia
Submit Docs

HACS (Home Assistant Community Store)

website·Indexed 35 days ago

https://hacs.xyz/

Documentation for HACS, an integration that allows users to discover, download, and manage custom elements for Home Assistant. It provides guides on publishing integrations, themes, plugins, and Python scripts, as well as troubleshooting, diagnostics, and contribution workflows for the backend and frontend.

Tokens
22.4K
Snippets
66
Records
221
Agent score
71%

What's inside HACS

  1. Overview of Home Assistant Community Store (HACS)

    The Home Assistant Community Store (HACS) is a custom integration for Home Assistant that provides a user interface to discover, download, update, and remove custom elements. Additionally, it allows developers to publish their own custom element repositories and create shortcuts to repositories or issue trackers.

  2. Overview of Home Assistant Community Store (HACS)

    The Home Assistant Community Store (HACS) is a custom integration for Home Assistant that provides a user interface to discover, download, update, and remove custom elements. It also allows developers to publish their own custom element repositories and create shortcuts to repositories or issue trackers.

  4. Verify system requirements for HACS installation

    Before installing HACS, ensure the following prerequisites are met:

    • Home Assistant Version: Must be running version 2024.4.1 or newer. (Check via Settings > About).
    • Installation Method: Must be using a supported Home Assistant installation method.
    • File System Access: You must have access to the file system where Home Assistant configuration files are stored.
    • Logging: You must know how to access the Home Assistant log file and how to enable debug logging.
    • Network: A stable internet connection is required. Outgoing requests to GitHub and Cloudflare must not be blocked.
    • Conceptual Understanding: HACS is not a Home Assistant 'app' in the glossary sense, even if an app is used to download it.

  5. Understand the difference between HACS and Home Assistant Apps

    HACS (Home Assistant Community Store) is an integration, not an app. It does not handle or manage Home Assistant apps; the two are completely different entities.

  6. Verify system requirements for HACS installation

    Before installing HACS, ensure the following prerequisites are met:

    • Home Assistant Version: Must be running version 2024.4.1 or newer. (Check via Settings > About).
    • Installation Method: Must be using a supported Home Assistant installation method.
    • File System Access: You must have access to the file system where Home Assistant configuration files are stored.
    • Logging: You must know how to access the Home Assistant log file and how to enable debug logging.
    • Network: A stable internet connection is required. Outgoing requests to GitHub and Cloudflare must not be blocked.
    • Conceptual Note: HACS is not an 'app' in the Home Assistant glossary sense, even if an app is used to download it.

  8. Understand the difference between HACS and Home Assistant Apps

    HACS is a Home Assistant integration, not an app or add-on. It does not manage, install, or handle Home Assistant apps. These are two distinct systems with different purposes.

  9. Understand why HACS requires a GitHub account

    HACS requires a GitHub account to authenticate requests to the GitHub API. Unauthenticated requests are limited to 60 per hour, which is insufficient for gathering information about available and downloaded repositories. By using an OAuth token with no scopes, HACS can make authenticated requests with a significantly higher rate limit. This token provides read-only access to public information, including user profiles, repository data, and gists.

  10. Verify HACS installation compatibility

    HACS (Home Assistant Community Store) is not limited to hass.io. It can be installed and used on any officially supported Home Assistant installation method.

  11. Understand the HACS element download process

    When downloading an element (such as an integration, dashboard, or template) via HACS, the system performs the following sequence of actions to ensure a clean installation:

    1. Deletes the existing local target directory (folder).
    2. Creates a new local target directory.
    3. Downloads all expected files into that directory.

    The specific files downloaded are determined by the type of element being installed.

  12. Understand the HACS element download process

    When downloading an element (such as an integration, dashboard, or template) via HACS, the system performs the following sequence of actions to ensure a clean installation:

    1. The existing local target directory (folder) for that element is deleted.
    2. A new local target directory is created.
    3. All expected files for the element are downloaded into the new directory.
    4. The specific files downloaded are determined by the type of element being installed.