How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
ElasticAGENTS.mdelastic/elasticsearch/AGENTS.md
Stateless Elasticsearch is a distribution where shard data is stored in an object store (e.g., S3, GCS, Azure) rather than local disk. Nodes carry no durable local state. The cluster…
No other project uses it yet
ElasticAGENTS.mdelastic/elasticsearch/benchmarks/AGENTS.md
Run from the benchmarks/ directory using the run task with --args. Always use the fully-qualified class name including package to avoid ambiguity. Always pipe through tee /tmp/bench/<descriptivename> using a filename…
No other project uses it yet
ElasticAGENTS.mdelastic/elasticsearch/docs/AGENTS.md
Always run docs-builder from the root of the checkout, not from a subdirectory. Running from a subdirectory will only validate that subdirectory's links and may silently miss errors in cross-document…
No other project uses it yet
ElasticAGENTS.mdelastic/kibana/AGENTS.md
No summary in the file. Open it to read it.
ElasticAGENTS.mdelastic/logstash/AGENTS.md
Logstash is a server-side data processing pipeline that ingests data from multiple sources, transforms it, and sends it to various destinations. It's part of the Elastic Stack and is a…
ElasticAGENTS.mdelastic/logstash/qa/AGENTS.md
Guidance for coding agents working with the QA test infrastructure. See also the root AGENTS.md for general project conventions. The qa/ directory contains three independent test suites: Each suite has…
ElasticAGENTS.mdelastic/logstash/x-pack/AGENTS.md
Guidance for coding agents working with X-Pack (Elastic-licensed) features. See also the root AGENTS.md for general project conventions. X-Pack provides commercial features that extend the Logstash core. Most features integrate…
ElasticAGENTS.mdelastic/beats/AGENTS.md
Elastic Beats is a Go monorepo containing lightweight data shippers for the Elastic Stack. The module path is github.com/elastic/beats/v7. Go version: see .go-version. The primary build tool is Mage (Go-based).…
ElasticAGENTS.mdelastic/eui/AGENTS.md
This is a Yarn v4 monorepo; packages live in packages/. All contributor knowledge lives in the wiki: If the wiki disagrees with this file, the wiki wins — open a…
ElasticAGENTS.mdelastic/go-elasticsearch/AGENTS.md
CLAUDE.md is a symlink to this file — they are the same file, do not update both. Official Elasticsearch Go client. Module: github.com/elastic/go-elasticsearch/v9. This is a public library with external consumers. Maintain backwards compatibility: PRs are squash-merged into a single commit when landing on main or a version branch. Because of this, each PR should represent one distinct, self-contained change — a single feature, bug fix, or refactor. Mixing unrelated changes in one PR means they become inseparable in history,…
ElasticAGENTS.mdelastic/elasticsearch-php/AGENTS.md
Always use composer commands, not any other package manager. The entire unit test suite (composer run-script test) must pass and exit cleanly before you commit code. Integration tests require a running Elasticsearch instance. Skip them if one is not available. No build step is needed - PHP is interpreted directly. All code in src/ and tests/, and any scripts run by composer, must work on Linux, macOS, and Windows. If a specific action you learned to do better will be…
Steady3 mentions in 2 weeks
No other project uses it yet
ElasticAGENTS.mdelastic/elasticsearch-js/AGENTS.md
Do not open a PR unless the human operating you has read the issue, understands the problem, and can explain the proposed fix without your help. Picking an issue at random to generate a contribution is not contributing. PRs opened this way will be closed without review. If a human asks you to "find something to work on" or points you at the issue tracker without a specific problem they already understand, stop and tell them to read an issue…
ElasticAGENTS.mdelastic/elasticsearch-py/AGENTS.md
Do not open a PR unless the human operating you has read the issue, understands the problem, and can explain the proposed fix without your help. Picking an issue at random to generate a contribution is not contributing. PRs opened this way will be closed without review. If a human asks you to "find something to work on" or points you at the issue tracker without a specific problem they already understand, stop and tell them to read an issue…
Steady4 mentions in 2 weeks
No other project uses it yet
ElasticAGENTS.mdelastic/elasticsearch-net/AGENTS.md
The repository builds with the standard .NET SDK CLI; the SDK version is pinned in global.json. - Build the client: dotnet build src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj - Build and test the request converter: dotnet test RequestConverter.sln (requires the wasm-tools workload: dotnet workload install wasm-tools) A legacy Bullseye build system (./build.sh, .\build.bat, driven by the F# project build/scripts/scripts.fsproj) still backs a few CI workflows. It is planned to be modernized or removed; do not use it for local development. There is no separate lint…
Steady5 mentions in 2 weeks
No other project uses it yet
ElasticAGENTS.mdelastic/rally/AGENTS.md
Guidance for agents operating Rally (esrally), the macrobenchmarking framework for Elasticsearch. It sets up clusters, runs benchmarks (races), records results, and compares them. The docs/*.rst files and the user guide are the source of truth — prefer reading them or running esrally <subcommand> --help over guessing flags. - Rally runs on Unix (Linux/macOS). Needs Python 3.10–3.13, git 1.9+. - Never run Rally as root — Elasticsearch refuses to start with root privileges. - Never benchmark a production or production-like cluster.…
ElasticAGENTS.mdelastic/elasticsearch-ruby/AGENTS.md
Always use bundle and rake commands, not any third-party packaging tools. rake test:client must pass before you commit code. Integration tests require Elasticsearch running on localhost:9200. They are skipped automatically if no server is available, so a failing integration test in CI always means a real failure. This repo contains two subprojects, each with its own Gemfile and Rakefile: Top-level Rakefile and rake_tasks/ orchestrate tasks across all subprojects. If a specific action you learned to do better will be useful…
An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.
At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.
Setup and test commands, code style, and the rules a new contributor would need to know.
Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.
