# AGENTS.md

RAGFlow is a leading open-source Retrieval-Augmented Generation (RAG) engine that fuses cutting-edge RAG with Agent capabilities to create a superior context layer for LLMs

## Setup

```
uv sync
```

## Commands

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

## Layout

- `internal/` 2173 source files
- `web/`      1396 source files
- `test/`     530 source files
- `rag/`      201 source files
- `api/`      143 source files
- `common/`   108 source files

## Conventions

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

## Gotchas

- `web/public/iconfont.js` is 222KB. 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.