agentleFS

AGENTS.md examples from real projects

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

Best matches · from page 21Worked for most · soon
railsAGENTS.md

rails

rails/rails/AGENTS.md

them should not break others unless there's an explicit dependency. ## Testing Commands ### Running Tests in a Component From within the component directory (preferred method): ```bash cd actionview && bin/test

Steady7 mentions in 2 weeks

No other project uses it yet

59k21mo agoReviewMountCreate a free account to mount
Gathin23AGENTS.md

tv-vibehack

Gathin23/tv-vibehack/AGENTS.md

theme's `config.json`, for this TV. Do not edit the repo's docs, tests or other code, and do not open issues or pull requests unless the person asks

1 project uses a version of this

59k21d agoReviewMountCreate a free account to mount
router-for-meReads credentialsAGENTS.md

CLIProxyAPI

router-for-me/CLIProxyAPI/AGENTS.md

build -o cli-proxy-api ./cmd/server # Build go run ./cmd/server # Run dev server go test ./... # Run all tests go test -v -run TestName ./path/to/pkg # Run single test go build

No other project uses it yet

59k5mo agoReviewMountCreate a free account to mount
ultralyticsAGENTS.md

yolov5

ultralytics/yolov5/AGENTS.md

solution. Avoid impossible-state handling, speculative flags, compatibility shims, policy scaffolding, and unrelated cleanup. Tests are out of scope by default — rely on existing coverage and focused validation; only

No other project uses it yet

58k3mo agoReviewMountCreate a free account to mount
appwriteAGENTS.md

appwrite

appwrite/appwrite/AGENTS.md

Start per-queue worker and scheduler containers instead | | `docker compose exec appwrite test tests/e2e/Services/[Service]` | Run E2E tests for a service | | `docker compose exec appwrite test tests/e2e/Services/[Service] --filter=[Method

No other project uses it yet

58k32d agoReviewMountCreate a free account to mount
ChromeDevToolsAGENTS.md

chrome-devtools-mcp

ChromeDevTools/chrome-devtools-mcp/AGENTS.md

from `package.json` to run commands. - Use `npm run build` to compile the project and tests with GN and Ninja. - Update `src/BUILD.gn` or `tests/BUILD.gn` whenever adding, renaming, or removing `.ts` files

Steady22 mentions in 2 weeks

No other project uses it yet

57k6mo agoReviewMountCreate a free account to mount
ayghriAGENTS.md

i-have-adhd

ayghri/i-have-adhd/AGENTS.md

plugin metadata. | | Documentation | `README.md`, `INSTALL.md`, `.github/readme/`, `.github/install/` | User-facing overview, installation, and translations. | | Verification | `tests/`, `scripts/` | Unit tests, compatibility checks, and evaluation tooling. | | Contribution workflow | `CONTRIBUTING.md`, `.github/pull_request_template.md` | Authorship, labels, safety

Steady6 mentions in 2 weeks

1 project uses a version of this

57k5mo agoReviewMountCreate a free account to mount
FuelLabsAGENTS.md

fuel-core

FuelLabs/fuel-core/AGENTS.md

enforces warnings as errors. ## Commands (matrix) | Step | Command | | :--- | :--- | | Setup | `cargo fetch` | | Build | `cargo build` | | Test | `cargo test` | | **Format (required)** | `cargo +nightly-2025-09-28 fmt --all` then `-- --check` | | Lint | `cargo

No other project uses it yet

57k21mo agoReviewMountCreate a free account to mount
BlockAGENTS.md

goose

block/goose/AGENTS.md

Build ```bash cargo build # debug cargo build --release # release just release-binary # release binary ``` ### Test ```bash export GOOSE_DISABLE_KEYRING=1 # avoid system keyring prompts cargo test # all tests cargo

1 project uses a version of this

57k4mo agoReviewMountCreate a free account to mount
remix-runDeletes or force-pushesAGENTS.md

react-router

remix-run/react-router/AGENTS.md

Guide ## Commands - **Build**: `pnpm build` (all packages) or `pnpm run --filter build` (single package) - **Test (Jest)**: `pnpm test` (all packages), `pnpm test packages/ /` (single package), `pnpm test packages/react-router/__tests__/router/fetchers-test.ts` (single file

No other project uses it yet

57k25d agoReviewMountCreate a free account to mount
HKUDSReads credentialsAGENTS.md

DeepTutor

HKUDS/DeepTutor/AGENTS.md

encryption python scripts/install_extras.py math-animator # Manim; also needs system LaTeX/ffmpeg python scripts/install_extras.py dev # Test / lint tooling python scripts/install_extras.py all # Full + Manim + dev dependencies ``` Stop DeepTutor before module changes. Source supports

Steady5 mentions in 2 weeks

No other project uses it yet

57k3mo agoReviewMountCreate a free account to mount
multica-aiReads credentialsAGENTS.md

multica

multica-ai/multica/AGENTS.md

Next.js proxy reads. Lint enforces the import, `process.env`, and Web Storage rules outside tests (`packages/core/eslint.config.mjs`). | | `packages/ui/` | UI primitives and shared styles. No business logic or `@multica/core` imports. | | `packages/views/` | Shared web/desktop

No other project uses it yet

56k20d agoReviewMountCreate a free account to mount
TryGhostAGENTS.md

Ghost

TryGhost/Ghost/AGENTS.md

package READMEs. Start with: - [Development setup](docs/contributing/development-setup.md) - [Contribution workflow](docs/contributing/workflow.md) - [Writing codebase documentation](docs/contributing/documentation.md) - [Testing](docs/contributing/testing.md) - [Shipping](docs/contributing/shipping.md) - [Codebase direction](docs/codebase/direction.md) - [Monorepo structure](docs/codebase/monorepo-structure.md) ## Required workflow - Always use `pnpm`, never

No other project uses it yet

56k4d agoReviewMountCreate a free account to mount
TryGhostAGENTS.md

Ghost / e2e

TryGhost/Ghost/e2e/AGENTS.md

AGENTS.md Read the canonical human documentation before changing this workspace: - [Writing Browser E2E Tests](../docs/contributing/e2e-testing.md) covers test structure, Page Objects, locator priority, waiting, and validation. - The [E2E workspace README](./README.md

No other project uses it yet

56k4d agoReviewMountCreate a free account to mount
bmad-code-orgAGENTS.md

BMAD-METHOD

bmad-code-org/BMAD-METHOD/AGENTS.md

Running and verifying - To validate skills: `uv run tools/validate_skills.py --strict`. - To run the Python tests: `uv run --frozen python -B -m pytest`. ## Conventions that differ from defaults - Skills, workflows, tasks

Steady3 mentions in 2 weeks

No other project uses it yet

55k58d agoReviewMountCreate a free account to mount
NutlopeAGENTS.md

hallmark

Nutlope/hallmark/AGENTS.md

node skills/hallmark/scripts/theme.mjs validate skills/hallmark/references/themes/*.md node skills/hallmark/scripts/theme.mjs index && git diff --exit-code -- skills/hallmark/references/themes/index.json node --test skills/hallmark/scripts/*.test.mjs skills/hallmark/scripts/fixtures/*/*.test.mjs ``` Browser tests skip without Chrome and puppeteer-core, and they always

Steady40 mentions in 2 weeks

No other project uses it yet

55k6d agoReviewMountCreate a free account to mount
mozillaAGENTS.md

pdf.js

mozilla/pdf.js/AGENTS.md

bash npx gulp server ``` Then open http://localhost:8888/web/viewer.html to view the PDF viewer. Test PDFs are available at http://localhost:8888/test/pdfs/?frame ### Building Build for modern browsers: ```bash

No other project uses it yet

54k22mo agoReviewMountCreate a free account to mount
boykopovarAGENTS.md

AnyPS5

boykopovar/AnyPS5/AGENTS.md

body: copy [the template](.github/pull_request_template.md), keep every line, tick every box, and fill `What`, `Tested`, `Depends on` (#N or none), `Fixes` (Fixes #N or none), `Unblocks` (title ID and discussion

No other project uses it yet

54k24d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

kotlin / analysis

JetBrains/kotlin/analysis/AGENTS.md

ownership with `withValidityAssertion` - Mark experimental APIs with `@KaExperimentalApi`, implementation details with `@KaImplementationDetail` ## Working with Test Data When modifying test data files or running generated tests (`*Generated`) that compare output against

No other project uses it yet

54k12d agoReviewMountCreate a free account to mount
JetBrainsAGENTS.md

kotlin / compiler

JetBrains/kotlin/compiler/AGENTS.md

mostly related to FIR (`compiler/fir/`), use `FIR: ` prefix in the commit subject line. - **Test-before-fix**: When fixing an issue and adding a test, commit the test data

No other project uses it yet

54k12d 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.