# AGENTS.md

The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface.

## Setup

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

## Commands

```
ruff check .   # lint
```

## Layout

- `comfy/`           305 source files
- `comfy_extras/`    156 source files
- `tests-unit/`      102 source files
- `comfy_api_nodes/` 86 source files
- `app/`             36 source files
- `comfy_api/`       36 source files

## Conventions

- Tests live alongside the code they cover, following `tests-unit/app_test/custom_node_manager_test.py`.
- CI defines what passing means. See `.github/workflows/api-node-template.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `comfy_api_nodes/apis/__init__.py` is 209KB. 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.