hacs

Rules for packaging a Home Assistant integration for HACS, the Home Assistant Community Store.

In plain words
What is it for?
Use them when creating or releasing the ha_gitops integration and checking its manifest, HACS files, versions, and brand images.
Why use it?
They ensure the integration has the required metadata, versioning, documentation links, branding, and release structure.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/ckrl/ha-gitops/hacs
Clone the repo
git clone --depth 1 https://github.com/ckrl/ha-gitops

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 1,100 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.01100
Opus 5 $0.00000 $0.00550
Sonnet 5 $0.00000 $0.00220
Haiku 4.5 $0.00000 $0.00110

Measured yesterday against content hash 00f34fcf984e, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

hacs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/hacs.mdc · 95 lines

How it starts

The opening of the file, as written. The whole thing — 95 lines — stays where its author put it; the contents beside it link to each section on GitHub.

HACS Rules

См. docs/architecture.md §5.2–5.3 и §12.

manifest.json (custom_components/ha_gitops/manifest.json)

Обязательные поля:

{
  "domain": "ha_gitops",
  "name": "HA GitOps",
  "version": "X.Y.Z",
  "documentation": "https://github.com/<owner>/ha-gitops",
  "issue_tracker": "https://github.com/<owner>/ha-gitops/issues",
  "requirements": [],
  "dependencies": [],
  "codeowners": ["@<owner>"],
  "iot_class": "cloud_polling",
  "config_flow": true
}

Правила:

  • domain навсегда = ha_gitops. Не менять.
  • version — semver (MAJOR.MINOR.PATCH). Поднимать в каждом релизе. Должен совпадать с git-тегом (vX.Y.Z).
  • requirements — пусто в MVP (зависимость на git binary не Python). В Release добавить "GitPython>=3.1" (точное имя пакета на PyPI).
  • iot_class = cloud_polling — удалённый Git по SSH/сеть; в HA классификатор cloud_* отражает необходимость исходящего интернета для пользовательского UI.
  • config_flow = true (MVP: UI Config Flow в config_flow.py).
  • codeowners — массив GH-handles с @.
  • Brand images — каталог custom_components/ha_gitops/brand/ с минимум icon.png (квадратная иконка; см. HA brand images). Для HA 2026.3+ локальный brand/ подхватывается API /api/brands/integration/…; HACS ожидает brand-ассеты в репозитории интеграции.

hacs.json (в корне репо)

{
  "name": "HA GitOps",
  "filename": "ha_gitops.zip",
  "content_in_root": false,
  "hide_default_branch": false,
  "homeassistant": "2024.1.0"
}
  • content_in_root: false — компонент лежит в custom_components/ha_gitops/.
  • homeassistant — минимальная поддерживаемая версия HA. Поднимать только при намеренном переходе.
  • filename — для совместимости с старыми установщиками; современный HACS это поле часто игнорирует, но оставляем.

Валидация в CI (.github/workflows/validate.yml)

Минимум обязательные шаги:

  • hassfesthome-assistant/actions/hassfest@master (валидирует manifest.json и структуру).
  • HACS validationhacs/action@main с category: integration.
  • pytest — на матрице Python 3.11/3.12.
  • Линт/формат — ruff check, black --check.

Read the full file on GitHub · 95 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 95 lines · 0 tokens per session scan A 00f34fcf984e

Subscribe to this mod's changes

hacs is a cursor rule published in the GitHub repository ckrl/ha-gitops (4 stars, last pushed 3mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,100 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.