agentleFS

AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Worked for most · soon
ElasticAGENTS.md

elastic-transport-go

elastic/elastic-transport-go/AGENTS.md

CLAUDE.md is a symlink to this file. elastic-transport-go is the shared HTTP transport layer for Elastic Go clients (e.g. go-elasticsearch). It provides connection pooling, node discovery, retry logic, request compression, OpenTelemetry instrumentation, interceptors, and logging. All code lives in a single package: elastictransport. Everything is in the elastictransport package. There is no cmd/, internal/, or multi-package structure. Client (elastictransport.go) — The Client struct implements Interface (the Perform(*http.Request) method). It owns the retry loop, request decoration (auth, headers, compression), and delegates…

147mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

esql-js

elastic/esql-js/AGENTS.md

packages/pretty-printer/ (@elastic/pretty-printer) is a standalone, dependency-free Wadler-Lindig document algebra and layout engine. @elastic/esql depends on it. packages/esql-types/ (@elastic/esql-types) holds all public TypeScript type definitions for the ES|QL and PromQL ASTs.…

1424d agoReviewMountCreate a free account to mount
ElasticAGENTS.md

ai-github-actions

elastic/ai-github-actions/AGENTS.md

@README.md @DEVELOPING.md @docs/upgrading.md Runs are executed in non-interactive CI and state is ephemeral between runs. Persist outcomes through safe outputs (comments/issues/PRs), because uncaptured local state is lost after the run.

114mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

elastic-transport-js

elastic/elastic-transport-js/AGENTS.md

Always use npm commands, not yarn, pnpm or any other third-party packaging tool. The entire test suite (npm test) must pass and exit cleanly before you commit code. All code in src/ and test/, and any scripts run by npm that are defined in package.json, must be runnable with equivalent results on Linux, MacOS and Windows. For example, running the following scripts using npm run: All markdown instructions authored for other agents must be as concise as possible. If a…

89mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

gradle-plugins

elastic/gradle-plugins/AGENTS.md

See README.md for why this repository exists, who or what uses it, and its responsibility boundary. When a change breaks backward compatibility, update version-next to the appropriate next major version as part of the same change. If version-next already targets that major release, keep it; multiple breaking changes in one unreleased version do not each require another major bump. Preserve compatibility between the Develocity Gradle plugin and the deployed Develocity server. The server observed during the 2.0.0 release was 2025.3.3,…

849d agoReviewMountCreate a free account to mount
ElasticAGENTS.md

metricsgenreceiver

elastic/metricsgenreceiver/AGENTS.md

Follow CONTRIBUTING.md for the canonical contributor guidance, especially for built-in scenario authoring. Repo-specific execution notes:

77mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

observability-migration-platform

elastic/observability-migration-platform/AGENTS.md

This file is for automation and repo-working guidance. Public user and contributor documentation lives in README.md, docs/README.md, and the root governance files. These names all refer to this project; do…

72mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

github-actions

elastic/github-actions/AGENTS.md

No summary in the file. Open it to read it.

67mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

jingra

elastic/jingra/AGENTS.md

Jingra Java project instructions

66mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

vault-secrets-buildkite-plugin

elastic/vault-secrets-buildkite-plugin/AGENTS.md

Guidance for AI agents (and humans skimming for the same context) working in this repository. A Buildkite plugin, implemented as a single Bash hook (hooks/environment), that fetches a secret from…

53mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

autoops-install

elastic/autoops-install/AGENTS.md

When modifying tools/checkconnectivity.sh, always update tools/testcheck_connectivity.sh to reflect the changes:

37mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

schemas-js

elastic/schemas-js/AGENTS.md

The majority of code in this repo is generated from API specs. Whenever a change is needed to a generated file, the actual fix should be made upstream in the elastic-client-generator-js repo and then codegen should be rerun. The repo is very likely available in an adjacent directory to this repo in most dev environments. Always check if ../elastic-client-generator-js exists and make edits there if it's available, and the changes don't clobber other in-progress work. Otherwise, respond with instructions for…

32mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

oblt-aw

elastic/oblt-aw/AGENTS.md

Use .github/remote-workflow-template/ as the source for distributed client workflows (per org subtree, for example obs/.github/workflows/trigger-obs-aw-<workflow-id>.yml, docs/.github/workflows/trigger-docs-aw-.yml, security/.github/workflows/trigger-security-aw-.yml). Distribute installs those files into active repositories, including this control-plane repo when listed in active-repositories.json (pilot / @main early detection). See docs/workflows/obs-aw-client-template.md, docs/workflows/docs-aw-client-template.md, docs/workflows/security-aw-client-template.md, and CONTRIBUTING.md. Do not hand-edit installed .github/workflows/trigger--aw-.yml copies; do not reintroduce a monolithic oblt-aw.yml or oblt-aw-ingress.yml. When hardening E2E gates (or addressing fail-closed review comments), follow .cursor/rules/fail-closed-e2e-gates.mdc: walk producer → outcome → oracle → tests and close every substitute…

218d agoReviewMountCreate a free account to mount
ElasticAGENTS.md

search-workshop / website

elastic/search-workshop/website/AGENTS.md

Document any regressions or Elasticsearch errors in the PR description.

212mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

ci-gh-actions

elastic/ci-gh-actions/AGENTS.md

This public repository publishes two independent reusable GitHub Actions. See the fetch-github-token README and the with-post-step README for why each action exists, who uses it, and its responsibility boundary. Each…

118d agoReviewMountCreate a free account to mount
ElasticAGENTS.md

dashboard-alert-migration / mig-to-kbn

elastic/dashboard-alert-migration/mig-to-kbn/AGENTS.md

This file is for automation and repo-working guidance. Public user and contributor documentation lives in README.md, docs/README.md, and the root governance files. These names all refer to this project; do…

08mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

dashboards-api-spec

elastic/dashboards-api-spec/AGENTS.md

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ before writing any code. Heed deprecation…

188 projects use a version of this

07mo agoReviewMountCreate a free account to mount
ElasticAGENTS.md

distillate

elastic/distillate/AGENTS.md

Canonical, tool-agnostic instructions for any coding agent working in this repository. Distillate is a theme-agnostic CSS style engine. It has one runtime dependency (stylis) and three public entry points: .,…

052d agoReviewMountCreate a free account to mount
CLAUDE.md vs AGENTS.md

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.