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 19Worked for most · soon
scrapyAGENTS.md

scrapy

scrapy/scrapy/AGENTS.md

mypy` and `tox -e pylint`, and `tox -e docs` and `tox -e docs-tests` as well if you touched docs or docstrings. CI runs these first and skips the test

No other project uses it yet

65k2mo agoReviewMountCreate a free account to mount
localstackAGENTS.md

localstack

localstack/localstack/AGENTS.md

cloud stack that emulates AWS services (S3, Lambda, DynamoDB, etc.) for development and testing. It runs in Docker, provides AWS-like APIs locally, enabling offline workflows, integration testing

65k15mo agoReviewMountCreate a free account to mount
gsd-buildAGENTS.md

get-shit-done

gsd-build/get-shit-done/AGENTS.md

agents/`; docs are in `docs/`; logos and terminal images are in `assets/`. Root tests are in `tests/*.test.cjs`. The TypeScript SDK is isolated under `sdk/`, with source and Vitest tests

65k6mo agoReviewMountCreate a free account to mount
gsd-buildAGENTS.md

get-shit-done

gsd-build/get-shit-done/docs/AGENTS.md

research on user's decisions - Investigates implementation patterns for the specific phase domain - Detects test infrastructure for Nyquist validation mapping --- ### gsd-ui-researcher **Role:** Produces UI design contracts for frontend

65k6mo agoReviewMountCreate a free account to mount
usememosAGENTS.md

memos

usememos/memos/AGENTS.md

never by rewriting the body. See `docs/design/README.md`. Verify current behavior in source code and tests, not in design documents. - Brand copy (tagline, descriptions, README intro) comes verbatim from [`BRAND.md

No other project uses it yet

64k33d agoReviewMountCreate a free account to mount
gitAGENTS.md

git / po

git/git/po/AGENTS.md

reimplement. It generates `po/l10n-pending.json` with messages that need translation. ```shell l10n_extract_pending () { test $# -ge 1 || { echo "Usage: l10n_extract_pending " >&2; return 1; } PO_FILE="$1" PENDING="po/l10n-pending.json

3 projects use a version of this

64k3d agoReviewMountCreate a free account to mount
ghostty-orgAGENTS.md

ghostty

ghostty-org/ghostty/AGENTS.md

Demit-macos-app=false` to skip building the app bundle and speed up compilation. - **Test (Zig):** `zig build test` - Prefer to run targeted tests with `-Dtest-filter` because the full

Steady3 mentions in 2 weeks

No other project uses it yet

64k8mo agoReviewMountCreate a free account to mount
ghostty-orgAGENTS.md

ghostty / macos

ghostty-org/ghostty/macos/AGENTS.md

macos/build.nu [--scheme Ghostty] [--configuration Debug] [--action build]` - Output: `macos/build/ /Ghostty.app` (e.g. `macos/build/Debug/Ghostty.app`) - Run unit tests directly with `macos/build.nu --action test` ## AppleScript - The AppleScript scripting definition is in `macos/Ghostty.sdef`. - Guard AppleScript

Steady3 mentions in 2 weeks

3 projects use a version of this

64k8mo agoReviewMountCreate a free account to mount
marktextAGENTS.md

marktext

marktext/marktext/AGENTS.md

State management | Pinia 4 | | Routing | Vue Router 5 | | UI library | Element Plus | | Unit tests | Vitest 5 | | E2E tests | Playwright | | Package manager | pnpm >=10 workspace (`packageManager: pnpm@10.33.4`) | | Repo layout | pnpm

No other project uses it yet

64k47d agoReviewMountCreate a free account to mount
withastroAGENTS.md

astro

withastro/astro/AGENTS.md

YOUR changes made unused. - Don't remove pre-existing dead code unless asked. The test: Every changed line should trace directly to the user's request. # Goal-Driven Execution **Define

Steady2 mentions in 2 weeks

No other project uses it yet

64k3mo agoReviewMountCreate a free account to mount
tw93AGENTS.md

Pake

tw93/Pake/AGENTS.md

pnpm run format` | Format code (prettier + cargo fmt) | | `npx vitest run` | Unit and integration tests only (sub-second) | | `pnpm test -- --no-build` | Full suite minus the multi-arch real build

Steady6 mentions in 2 weeks

No other project uses it yet

64k58d agoReviewMountCreate a free account to mount
ultralyticsAGENTS.md

ultralytics

ultralytics/ultralytics/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

63k2mo agoReviewMountCreate a free account to mount
BerriAIPipes a download into a shellAGENTS.md

litellm

BerriAI/litellm/AGENTS.md

maintain/change - modern In descending order of importance When adding new features, add meaningful tests. Don't add tests that don't check anything substantial and is there just to make

No other project uses it yet

63k59d agoReviewMountCreate a free account to mount
BerriAIAGENTS.md

litellm

BerriAI/litellm/.github/AGENTS.md

merge bases check out full history. Removing a CI job does not count its tests as covered. List tests that no remaining job invokes explicitly in `ci-coverage-allowlist.yml

No other project uses it yet

63k59d agoReviewMountCreate a free account to mount
BerriAIAGENTS.md

litellm / tests

BerriAI/litellm/tests/AGENTS.md

Tests Nothing on the other side of the call: `tests/unit`. A proxy we start with an upstream we script: `tests/integration`. Someone else's service with real credentials: `tests/e2e`. Tests

No other project uses it yet

63k59d agoReviewMountCreate a free account to mount
makeplaneReads credentialsAGENTS.md

plane

makeplane/plane/AGENTS.md

store/` folder (`apps/web/store`, `apps/space/store`, `apps/admin/store`); stores shared across apps go in `packages/shared-state` - **Testing**: All features require unit tests, use existing test framework per package - **Components**: Primitives come from the published

No other project uses it yet

62k5d agoReviewMountCreate a free account to mount
penpotAGENTS.md

penpot

penpot/penpot/AGENTS.md

workflow/updating-changelog` (the `update-changelog` skill flow) or on explicit user request. - **Never pipe test output directly to filters** (`| head`, `| tail`, `| grep`, etc.). Always redirect to a file first: `command > /tmp/output.txt

Steady6 mentions in 2 weeks

No other project uses it yet

62k2mo agoReviewMountCreate a free account to mount
chen08209AGENTS.md

FlClash

chen08209/FlClash/AGENTS.md

agents/project.md): project overview, versions, and build dependencies. - [.agents/commands.md](.agents/commands.md): build, development, code generation, and test commands. - [.agents/rules.md](.agents/rules.md): lint, testing, generated-code, and workflow rules. Read these only when

No other project uses it yet

62k13d agoReviewMountCreate a free account to mount
pi-holeAGENTS.md

pi-hole

pi-hole/pi-hole/AGENTS.md

assets installed onto the system - `gravity.sh` - builds `gravity.db` from configured blocklists - `manpages/` - man pages - `test/` - BATS test suite, run inside distro-specific OCI containers ## Dev environment tips - You need Docker

No other project uses it yet

62k9d agoReviewMountCreate a free account to mount
pingdotggReads credentialsAGENTS.md

t3code

pingdotgg/t3code/AGENTS.md

copying from it are fine, and a good way to get real test data (see Test data). Never start a server against it, never open it read-write, never clean

No other project uses it yet

61k3d 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.