agentleFS
hass-energyhass-energy/haeo/.agents/skills/manifest/SKILL.md

manifest

Skill81 starsChanged 3 days agoMITView on GitHub

Home Assistant manifest requirements for custom_components/haeo/manifest.json and hacs.json — required fields, key order, config_flow, iot_class, dependencies and after_dependencies, requirements, and HACS compatibility. Use when editing manifest.json or hacs.json, or changing integration metadata, requirements, dependencies, or version.

10 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 9 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read it before changing it, and run hassfest afterwards as the lint skill describes.

    line 9
  2. Distinctive:

    All integrations must include:

    line 14
  3. Very specific:

    Add an integration there when HAEO starts importing from it.

    line 45

“Common” is measured: kept by at least 6 in 10 of the 9 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Manifest requirements

custom_components/haeo/manifest.json defines integration metadata for Home Assistant. Read it before changing it, and run hassfest afterwards as the lint skill describes. Hassfest requires domain and name first and the remaining keys in alphabetical order.

Required fields

All integrations must include:

  • domain: Integration domain name (lowercase, underscores only)
  • name: Human-readable display name
  • codeowners: GitHub usernames with @ prefix for notification
  • integration_type: Integration category (hub, device, service, etc.)
  • documentation: URL to documentation
  • requirements: Python package dependencies with version constraints
  • version: The release version, which must equal version in pyproject.toml; change it only through the update-version skill

Config flow

Set config_flow: true when the integration has UI-based configuration. This enables the integration to appear in the "Add Integration" dialog.

IoT class

The iot_class describes how the integration communicates:

  • local_push - Local network with push updates (preferred for local devices)
  • local_polling - Local network with polling
  • cloud_push - Cloud service with push updates
  • cloud_polling - Cloud service with polling
  • calculated - No external data, purely calculated values

Choose the class that best represents the primary data source.

Dependencies

dependencies lists integrations that must be set up before HAEO; use an empty array if there are none. after_dependencies lists integrations HAEO uses when present and must load after, without requiring them. Add an integration there when HAEO starts importing from it.

HACS compatibility

For HACS distribution:

  • Version field must be present
  • Requirements must use valid PyPI package names
  • hacs.json homeassistant is the minimum Home Assistant version and must equal the homeassistant>= pin in pyproject.toml; the version gate checks this
  • Documentation URL must be accessible
  • Issue tracker URL is recommended

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.