# AGENTS.md

:house_with_garden: Open source home automation that puts local control and privacy first.

## Setup

```
pip install -r requirements.txt
```

## Commands

```
pytest         # run the test suite
ruff check .   # lint
```

## Layout

- `homeassistant/` 9974 source files
- `tests/`         8213 source files
- `script/`        131 source files
- `pylint/`        67 source files
- `mypy_plugins/`  2 source files

## Conventions

- Tests live alongside the code they cover, following `homeassistant/components/assist_satellite/connection_test.py`.
- CI defines what passing means. See `.github/workflows/builder.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `tests/helpers/test_device_registry.py` is 466KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.