# AGENTS.md

LlamaIndex is the leading document agent and OCR platform

## Setup

```
uv sync
```

## Commands

```
make help
make format              # format
make lint                # lint
make test                # run the test suite, must pass before any commit
make test-core
make test-integrations
```

## Layout

- `llama-index-integrations/`    3043 source files
- `llama-index-core/`            735 source files
- `llama-dev/`                   23 source files
- `llama-index-instrumentation/` 21 source files
- `llama-index-utils/`           16 source files
- `docs/`                        10 source files

## Conventions

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

## Gotchas

- `llama-index-core/tests/node_parser/test_markdown_element.py` is 290KB. 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.