project-layout

A set of rules defining where files belong in a Home Assistant GitOps integration and what each package is responsible for. Home Assistant is software for controlling and monitoring smart-home devices.

In plain words
What is it for?
Use it when adding or changing integration setup, Git operations, sensors, buttons, configuration flows, translations, branding, services, or tests.
Why use it?
It keeps the project structure predictable and prevents code from being placed in the wrong module without updating the architecture documentation.

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/project-layout
Clone the repo
git clone --depth 1 https://github.com/ckrl/ha-gitops

Made for: Cursor.

Per session 937 This file is loaded in full into every session.
When invoked 937 The same file — it is already loaded in full.
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.00937 $0.00937
Opus 5 $0.00468 $0.00468
Sonnet 5 $0.00187 $0.00187
Haiku 4.5 $0.00094 $0.00094

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

Security

Grade A, and why

project-layout 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/project-layout.mdc · 62 lines

How it starts

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

Project Layout (keep this shape)

Опорная схема — docs/architecture.md §5.1. Не меняй без обновления документа.

ha-gitops/
├── custom_components/
│   └── ha_gitops/
│       ├── __init__.py          # async_setup / async_setup_entry (services) / async_unload_entry
│       ├── manifest.json        # HACS manifest (domain, version, codeowners, iot_class)
│       ├── const.py             # DOMAIN, CONF_*, дефолты, ключи статусов
│       ├── git_manager.py       # ВСЯ git-логика; класс GitManager — единственная точка вызовов git
│       ├── sensor.py            # SensorEntity: sync status + local/remote/changed/last_sync
│       ├── button.py            # ButtonEntity: pull, fetch, push
│       ├── repairs.py           # RepairsFlow (issue_registry fix)
│       ├── config_flow.py       # UI Config Flow (MVP)
│       ├── services.yaml        # описание сервисов
│       ├── strings.json         # UI-строки (en по умолчанию)
│       ├── brand/               # icon.png (и при необходимости logo.png) для HA/HACS
│       └── translations/
│           └── ru.json            # Russian UI (en defaults in strings.json)
├── tests/
│   ├── conftest.py              # фикстуры HA + временный git repo
│   ├── test_git_manager.py      # unit + integration тесты GitManager
│   ├── test_sensor.py
│   ├── test_inspection_snapshot.py
│   ├── test_ssh_keygen.py
│   ├── test_button.py
│   ├── test_config_flow.py
│   ├── test_service.py
│   ├── test_repairs.py
│   └── test_setup.py
├── docs/                        # architecture.md — design of record
├── hacs.json                    # HACS metadata (см. hacs.mdc)
├── README.md                    # установка, configuration.yaml пример, prerequisites
├── LICENSE                      # MIT
├── pyproject.toml               # dev-зависимости, pytest config, ruff/black
└── .github/workflows/
    ├── validate.yml             # hassfest + HACS validation + pytest
    └── release.yml              # автотег + release notes

Ответственность модулей

Read the full file on GitHub · 62 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 · 62 lines · 937 tokens per session scan A 0fdbf018e973

Subscribe to this mod's changes

project-layout is a cursor rule published in the GitHub repository ckrl/ha-gitops (4 stars, last pushed 3mo ago), licensed MIT. It adds 937 tokens to every session, about $0.0047 per session on Opus 5. 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.