# AGENTS.md

Free and Open Source, Distributed, RESTful Search Engine

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## 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

- `x-pack/`               10252 source files
- `server/`               8318 source files
- `modules/`              1851 source files
- `libs/`                 1110 source files
- `test/`                 811 source files
- `build-tools-internal/` 381 source files

## Conventions

- Tests live alongside the code they cover, following `.buildkite/scripts/flakiness-detection/analyzer/analyze.test.ts`.
- CI defines what passing means. See `.github/workflows/check-esql-generated-headers.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/optimizer/PhysicalPlanOptimizerTests.java` is 559KB. 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.