General
For your repository to be added there are several criteria that need to be met.
- General requirements
- Integration requirements for integrations.
- Plugin requirements for plugins.
- AppDaemon requirements for AppDaemon apps.
- Python_scripts requirements for python scripts.
- Theme requirements for themes.
General requirements
Description
Your repository on GitHub needs to have a description that in a few words describes the purpose of the repository. This description is used in HACS.
Topics
Your repository on GitHub needs to have topics. Topics are not displayed in HACS, but they can be used for searchability in the HACS store.
README
Your repository needs to have a readme with information about how to use it. This is not used in HACS, unless you have defined the key render_readme in hacs.json below.
info.md
If you want to add a richer experience for your users you can add an info.md file to the root of your repository, this file will be rendered under the repository description. It does not support the full styling options from GitHub, so use with care. This is optional, if you do not have this file you need to set the key render_readme in the hacs.json file to true.
See the Templates section on how you can make this awesome
hacs.json
This is a special manifest file that both defines the information that HACS shows in the UI and what files/paths that HACS should use. This file must be located in the root of your repository.
The following keys are supported:
| Key | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The display name that will be used in the HACS UI. |
content_in_root | bool | No | Indicates whether the content is in the root of the repository as opposed to in a subdirectory. |
zip_release | bool | No | Indicates whether the content is in a zipped archive when releases are published on GitHub. If you use this you also need to add filename. |
filename | string | No | Name of the file HACS should look for, only applies to single item categories (plugin, theme, python_scripts, zip_release). |
render_readme | bool | No | Tells HACS to render the README.md file instead of info.md. |
domains | string | No | A list of domains. |
country | string | No | Two character country code in ISO 3166-1 alpha-2 format. ISO 3166-1 alpha-2 on Wikipedia |
homeassistant | string | No | The minimum required Home Assistant version. |
persistent_directory | string | No | A relative path (within the integration directory) that will be kept safe during upgrades. Can only be used with integrations. |
iot_class | string | Only for integrations | The type of communication with the service/device. Types used in Home Assistant |
examples:
Versions
If the repository uses GitHub releases, the tagname from the latest release is used to set the remote version. Just publishing tags is not enough, you need to publish releases.
If the repository does not use tags, the 7 first characters of the last commit will be used.
Templates
You can use Jinja2 templates to control what and how the info is displayed. In addition to the default templates of Jinja these are added:
| Template value | Description |
|---|---|
| installed | True / False if it is installed. |
| pending_update | True / False if a update is pending. |
| prerelease | True / False if it's a pre release. |
| selected_tag | The selected version. |
| version_available | The latest available version. |
| version_installed | The installed version |
Examples
Prerelease
Here Travel Time
Some examples of info.md files
Custom Header
Lovelace Swipe Navigation
HomeAssistant-Atrea
Want to add your repository to the store as a default?
See here for how to add a custom repository.
Badges
Tell your users that your repository can be tracked with HACS.
Default repository
If your repository is in the default store.
Custom repository
If your repository can be added as a custom repository.
