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/fleet-server/AGENTS.md
This file guides AI agents working in this repository. For hands-on local setup (Docker, benchmarking, cloud), see docs/developers-guide.md. Fleet Server is the control plane for Elastic Agent management — it…
ElasticAGENTS.mdelastic/elastic-package/AGENTS.md
Run tests for specific packages: Run integration tests with test packages: Important: Linting before giving the task for complete. The import graph must be acyclic. The established layering is: elastic-package…
ElasticAGENTS.mdelastic/homebrew-tap/AGENTS.md
See README.md for why this repository exists, who or what uses it, and its responsibility boundary. For every AI tool that materially contributes to code, tests, documentation, configuration, or the substance of a change: For a squash merge, verify that the final squash commit message contains every attribution trailer. GitHub may populate that message from the pull-request description, commit information, or only the pull-request title depending on repository settings, so putting attribution in the PR description improves preservation but does…
ElasticAGENTS.mdelastic/workflows/AGENTS.md
This repository holds the Workflow Template Library content published to the CDN consumed by Kibana's Workflows app, plus a library of plain workflow examples.
ElasticAGENTS.mdelastic/ecctl/AGENTS.md
No summary in the file. Open it to read it.
ElasticAGENTS.mdelastic/package-registry/AGENTS.md
This project uses Mage as its build tool. Run mage without arguments to see all available targets. Package Registry is an HTTP service that serves Elastic integration packages to Kibana/Fleet.…
ElasticAGENTS.mdelastic/docs-content/AGENTS.md
This is the shared baseline for AI agents working in this repository. Claude Code reads it through CLAUDE.md, a symlink to this file. Cursor, Codex, and Copilot read AGENTS.md directly.…
ElasticAGENTS.mdelastic/esdiag/AGENTS.md
For deeper repository structure see docs/repository/organization.md - Update nearby docs when behavior changes - Update CHANGELOG.md for user-visible changes with .agents/skills/changelog/SKILL.md - Never introduce Python scripts into this repository. Do…
ElasticAGENTS.mdelastic/docs-builder/AGENTS.md
Elastic's documentation build toolchain. Processes Markdown from multiple repos into a unified documentation site, validates cross-repo references, serves with live reload, and ships as native AOT binaries for CI. CLI changes: after editing src/tooling/docs-builder/Commands/, regenerate docs/cli-schema.json: See CONTRIBUTING.md for supplemental CLI docs under docs/schema-support/cli-schema/. Tests live in tests/ (unit) and tests-integration/ (integration). Use the /test skill to pick the right test project automatically. A change to product code should land with a test that exercises it — the mapping from…
ElasticAGENTS.mdelastic/docs-builder/src/Elastic.ApiExplorer/AGENTS.md
Renders API reference documentation (landing, authentication, servers, operation, and schema type pages) from OpenAPI specifications, using Microsoft.OpenAPI's normalized object model as input and RazorSlices for HTML. Vertical slices (one folder per page feature) over MVVM-named horizontal layers: Every page the layout renders has the same two columns inside #api-content-grid: the article and a right rail (.api-page-grid in api-docs.css). The layout puts Copy page at the top of the rail; a view adds the rest by overriding ExecuteSectionAsync for ApiPageSections.Rail. Only…
ElasticAGENTS.mdelastic/docs-builder/src/Elastic.Documentation.Site/AGENTS.md
Shared Razor layout, the frontend bundles, and the design system. The full guide is docs/development/design-system.md; the living style guide runs at /style-guide under docs-builder serve.
ElasticAGENTS.mdelastic/docs-builder/src/Elastic.Markdown/AGENTS.md
The core Markdown parser: a Markdig extension that adds Myst-style directives and roles, plus the diagnostics, linting, and export machinery that turns a directory of .md files into rendered pages. Everything else in this repo (the CLI, the frontend, essc) consumes this project's output. Most directives are a 3-file folder under Myst/Directives/<Name>/: <Name>Block.cs (the Markdig block type), <Name>View.cshtml (Razor rendering), <Name>ViewModel.cs (data the view reads). Some have more files (e.g. Tabs/, Stepper/, Image/ render multiple sub-elements), and at least one…
ElasticAGENTS.mdelastic/docs-builder/src/services/search/Elastic.Documentation.Search.Contract/AGENTS.md
The shared document/mapping/analysis schema consumed by two independent indexers: the docs build pipeline (Elastic.Markdown/Exporters/Elasticsearch/ElasticsearchMarkdownExporter.cs) and essc (src/tooling/essc/). Nothing here should assume which one is calling it — that's the whole point of the project existing separately instead of living inside either. One folder per document type/concern; each document type owns its own *MappingConfig.cs and composes Common/SharedMappingConfig.cs's shared field mappings. Folder layout is concern-based but the project deliberately exposes only two namespaces — root and .Mapping — not one per folder;…
ElasticAGENTS.mdelastic/go-licence-detector/AGENTS.md
See README.md for why this repository exists, who or what uses it, and its responsibility boundary. For every AI tool that materially contributes to code, tests, documentation, configuration, or the substance of a change: For a squash merge, verify that the final squash commit message contains every attribution trailer. GitHub may populate that message from the pull-request description, commit information, or only the pull-request title depending on repository settings, so putting attribution in the PR description improves preservation but does…
ElasticAGENTS.mdelastic/package-spec/AGENTS.md
This document contains important information learned while working on the package-spec repository to help future AI agents working on this codebase. Maintainers preparing a versioned release (prepare-release-X.Y.Z, changelog finalization, compliance…
ElasticAGENTS.mdelastic/elastic-ramen/AGENTS.md
Prefer single word names for variables and functions. Only use multiple words if necessary. THIS RULE IS MANDATORY FOR AGENT WRITTEN CODE. Reduce total variable count by inlining when a value is only used once. Avoid unnecessary destructuring. Use dot notation to preserve context. Prefer const over let. Use ternaries or early returns instead of reassignment. Avoid else statements. Prefer early returns. Use snake_case for field names so column names don't need to be redefined as strings.
ElasticAGENTS.mdelastic/elastic-ramen/packages/opencode/AGENTS.md
Instructions to follow when writing Effect.
ElasticAGENTS.mdelastic/elastic-ramen/packages/opencode/test/AGENTS.md
The tmpdir function in fixture/fixture.ts creates temporary directories for tests with automatic cleanup. Git repository: With config file: Custom initialization (returns extra data): With cleanup:
ElasticAGENTS.mdelastic/example-mcp-dashbuilder/AGENTS.md
MCP app that lets AI assistants build Kibana dashboards using ES|QL and Elastic Charts. Monorepo with four workspaces: shared, setup, server, preview. A pre-commit hook runs lint-staged (format + lint…
ElasticAGENTS.mdelastic/elastic-otel-python/AGENTS.md
No summary in the file. Open it to read it.
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.
