aiohomematic: Instructions file for Codex

AGENTS.md

aiohomematic AGENTS.md is an instructions file for Codex, OpenCode from SukramJ/aiohomematic. It costs 702 tokens per session, scanned A, original, MIT.

Repository instructions for the aiohomematic Python project, covering its folders, development commands, coding conventions, and tests.

In plain words
What is it for?
Use them when working on aiohomematic code, running formatting and type checks, or adding and running pytest tests.
Why use it?
They give a coding agent the project-specific rules needed to make changes that fit the repository and pass its checks.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is SukramJ/aiohomematic's own configuration. It tells Codex and OpenCode how to work on aiohomematic itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything aiohomematic configures →

Reuse

Borrowing it

Nothing to install: this file belongs to SukramJ/aiohomematic. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/SukramJ/aiohomematic/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/SukramJ/aiohomematic

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for aiohomematic AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/sukramj/aiohomematic/agents-md.svg)](https://agentmods.dev/instructions/sukramj/aiohomematic/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/sukramj/aiohomematic/agents-md"><img src="https://agentmods.dev/badge/instructions/sukramj/aiohomematic/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 702 This file is loaded in full into every session.
When invoked 702 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00702 $0.00702
Opus 5 $0.00351 $0.00351
Sonnet 5 $0.00140 $0.00140
Haiku 4.5 $0.00070 $0.00070

Measured 8d ago against content hash f0e052990d8f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

aiohomematic AGENTS.md 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 8d ago.

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.

AGENTS.md · 41 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

  • aiohomematic/ hosts the async library (central/, client/, model/, store/) plus assets in rega_scripts/ and translations/.
  • aiohomematic_test_support/ supplies fixtures, playback data, and factories; prefer these over bespoke mocks.
  • tests/ contains the pytest suite with helpers/ and fixtures/; keep new tests adjacent to related code.
  • docs/ collects architecture, migration, and naming references; automation scripts live in script/ for prek use.

Build, Test, and Development Commands

  • python -m pip install -r requirements.txt -r requirements_test.txt installs runtime and tooling dependencies.
  • prek run --all-files mirrors CI hooks (sort-class-members, check-i18n, ruff, mypy, pylint, codespell, bandit, yamllint).
  • ruff format then ruff check --fix applies the required formatting, import order, and alias rules.
  • mypy aiohomematic aiohomematic_test_support runs strict type checks; justify any # type: ignore[code].
  • pytest tests/ runs the suite; use ./cov.sh for HTML coverage and pytest -k pattern -vv for focused runs.
  • pylint -j 0 aiohomematic covers the remaining lint gate; reuse the project virtualenv or script/run-in-env.sh.

Coding Style & Naming Conventions

  • Start every Python module with from __future__ import annotations, use 4-space indentation, and maintain curated __all__.
  • Let ruff manage import order and aliases; do not hand-sort or introduce new shortcuts.
  • Public surfaces require docstrings consistent with docs/docstring_standards.md.
  • Reuse helpers for device/channel naming (docs/naming.md) and shared enums or dataclasses from aiohomematic.const.
  • Keep async APIs cancellable and prefer keyword-only signatures for multi-parameter functions.

Testing Guidelines

  • Use pytest with @pytest.mark.asyncio; lean on factories in aiohomematic_test_support.factory and fixtures from tests/conftest.py.
  • Place new playback data in aiohomematic_test_support/data and document schema updates alongside the change.
  • Sustain ≥90 % coverage on core logic and ≥85 % overall; inspect htmlcov/index.html after ./cov.sh.
  • Name new test modules test_<feature>.py and park shared utilities in tests/helpers/.

Read the full file on GitHub · 41 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. 8d ago First seen · 41 lines · 702 tokens per session scan A f0e052990d8f

Subscribe to this mod's changes

aiohomematic AGENTS.md is an instructions file published in the GitHub repository SukramJ/aiohomematic (167 stars, last pushed today), licensed MIT. It adds 702 tokens to every session, about $0.0035 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-30.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens