# AGENTS.md

🚀🤖 Crawl4AI: Open-source LLM Friendly Web Crawler & Scraper. Don't be shy, join here: https://discord.gg/jP8KfhDhyN

## Setup

```
uv sync
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `tests/`    214 source files
- `docs/`     171 source files
- `crawl4ai/` 83 source files
- `deploy/`   49 source files
- `scripts/`  2 source files

## Conventions

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

## Gotchas

- `crawl4ai/utils.py` is 125KB. It will not fit comfortably in context, so read it in parts.

---

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.