# AGENTS.md

[EMNLP2025] LightRAG: Simple and Fast Retrieval-Augmented Generation

## Setup

```
uv sync
```

## Commands

```
make help
make dev            # run locally
make apple-up
make apple-down
make apple-status
make apple-logs
```

## Layout

- `tests/`          491 source files
- `lightrag/`       169 source files
- `lightrag_webui/` 115 source files
- `examples/`       30 source files
- `k8s-deploy/`     12 source files
- `scripts/`        10 source files

## Conventions

- Tests live alongside the code they cover, following `lightrag_webui/src/api/lightrag-stream.test.ts`.
- CI defines what passing means. See `.github/workflows/copilot-setup-steps.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `lightrag/api/static/swagger-ui/swagger-ui-bundle.js` is 1475KB. 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.