For your repository to be added there are a few 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.
Your repository on GitHub needs to have a description that in short tell what the content in the repository do.
This description is also used in HACS.
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.
Your repository needs to have a readme with information about how to use it. This is not used in HACS, but without this it's hard for the user to get started.
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 is optional, if you do not have this you need to set
render_readme in the
hacs.json file), this file will be rendered under the repository description, it does not support the full styling options as Github so use with care.
This is a special manifest file that both give information to HACS that are used in the UI, and tell it what to use and where it is, this file needs to be located in the root of your repository.
The following keys are supported:
|name||True||The display name that will be used in the HACS UI|
|content_in_root||False||Boolean to indicate that the content is in the root of the repository.|
|zip_release||False||Boolean to indicate that the content is in a zipped archive on the release, if you use this you also need to add |
|filename||False||Name of the file HACS should look for, only applies to single item categories (plugin, theme, python_scripts, zip_release)|
|render_readme||False||Tells HACS to render the README.md file instead of info.md|
|domains||False||A list of domains, |
|country||False||A2(ISO) variant of the country name https://www.worldatlas.com/aatlas/ctycodes.htm|
|homeassistant||False||The minimum required Home Assistant version|
|persistent_directory||False||This will only apply to integrations, a relative path (under the integration dir) that will be kept safe during upgrades.|
|iot_class||For integrations||The type of communication with the service/device|
This key can be a single value, or a list.
This is only for integrations.
If the repository uses GitHub releases, the tagname from the latest release is used to set the remote version. (**NB: just publishing tags is not enough, you need to publish releases)
If the repository does not use those, the 7 first characters of the last commit will be used.
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:
|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|
Some examples of
Want to add your repository to the store as a default?
Tell your users that your repository can be tracked with HACS.
If your repository is in the default store.
If your repository can be added as a custom repository.