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 10Worked for most · soon
windmill-labsReads credentialsAGENTS.md

windmill / backend

windmill-labs/windmill/backend/AGENTS.md

index. Under herdr the two server panes sit in the worktree's `backend/` and `frontend/`, so match on `cwd`: ```bash herdr pane list --workspace "$HERDR_WORKSPACE_ID" ``` Under webmux they

Steady21 mentions in 2 weeks

No other project uses it yet

18k11d agoReviewMountCreate a free account to mount
windmill-labsAGENTS.md

windmill / frontend

windmill-labs/windmill/frontend/AGENTS.md

Frontend (Svelte 5) - **Coding patterns**: MUST use the `svelte-frontend` skill when writing Svelte code - **Validation**: `docs/validation.md` — `npm run check:fast` (2s) for iteration, `npm run check` (50s) for final

Steady21 mentions in 2 weeks

No other project uses it yet

18k11d agoReviewMountCreate a free account to mount
eythaannAGENTS.md

Seelen-UI

eythaann/Seelen-UI/AGENTS.md

customizable Windows desktop environment built with: - Rust + Tauri (backend) - TypeScript + React/Preact (frontend) - A monorepo layout with shared libs under `libs/` ## Read First (Non-Negotiable) Build speed / safety

18k14mo agoReviewMountCreate a free account to mount
zincsearchReads credentialsAGENTS.md

zincsearch

zincsearch/zincsearch/AGENTS.md

built. ## Build / run Node.js 24 + npm; keep `frontend/package-lock.json` in sync. ```shell cd frontend && npm ci && npm run build && cd .. # REQUIRED before any go build/test ./sh/build.sh # frontend + versioned static binary

18k4y agoReviewMountCreate a free account to mount
Google CloudReads credentialsAGENTS.md

generative-ai / ge-demo-generator

GoogleCloudPlatform/generative-ai/search/gemini-enterprise/ge-demo-generator/AGENTS.md

mixed. Handed a menu of languages, the model sometimes picks one off it. The frontend already knows the intended language — the Template Hub selector, or the research language while research

Steady2 mentions in 2 weeks

No other project uses it yet

18k21d agoReviewMountCreate a free account to mount
AutomatticAGENTS.md

harper

Automattic/harper/AGENTS.md

architecture and its relationship to the Cargo workspace. ### Commands - Use `pnpm` for frontend packages; `harper-desktop/package.json` pins `pnpm@10.10.0`. - Dev app: `just dev-desktop` from repo root. It builds

Steady18 mentions in 2 weeks

No other project uses it yet

17k5mo agoReviewMountCreate a free account to mount
koelReads credentialsAGENTS.md

koel

koel/koel/AGENTS.md

base folders without approval. - Do not change the application's dependencies without approval. ## Frontend Bundling - If the user doesn't see a frontend change reflected in the UI, it could

17k5mo agoReviewMountCreate a free account to mount
coderAGENTS.md

coder

coder/coder/AGENTS.md

structure and research | [DOCS_STYLE_GUIDE.md](.claude/docs/DOCS_STYLE_GUIDE.md) | | New, moved, or restructured docs | [write-docs skill](.claude/skills/write-docs/SKILL.md) | | Frontend | [site/AGENTS.md](site/AGENTS.md) | For changes under `site/src/`, also read [FRONTEND_PATTERNS.md](.claude/docs/FRONTEND_PATTERNS.md). When you modify frontend code

17k20d agoReviewMountCreate a free account to mount
coderAGENTS.md

coder / site

coder/coder/site/AGENTS.md

Frontend Development Guidelines Read [Frontend Patterns](../.claude/docs/FRONTEND_PATTERNS.md) before changing `site/src/`. It is the canonical contract for FE1 through FE10. ## Frontend contract - **FE1:** UI behavior changes should have behavior coverage

17k20d agoReviewMountCreate a free account to mount
suitenumeriqueReads credentialsAGENTS.md

docs

suitenumerique/docs/AGENTS.md

database migrations make makemigrations # Create new migrations make resetdb # Flush DB + create superuser (admin/admin) ``` ### Frontend (TypeScript/Next.js) ```bash # From src/frontend/apps/impress/: yarn dev # Development server (port 3000) yarn build # Production build (includes

17k4mo agoReviewMountCreate a free account to mount
opfAGENTS.md

openproject

opf/openproject/AGENTS.md

data persistence. - **Size**: Large monorepo (~840MB, ~1M+ lines of code) - **Backend**: Ruby on Rails - **Frontend**: Node.js, npm, TypeScript - **Database**: PostgreSQL (required) - **Architecture**: Server-rendered HTML with Hotwire (Turbo + Stimulus). Legacy

17k5y agoReviewMountCreate a free account to mount
opfAGENTS.md

openproject / frontend

opf/openproject/frontend/AGENTS.md

Frontend ## Directory Structure - `./src/app/` — legacy Angular modules and components - `./src/common/` — framework-agnostic modules (the `core-common` alias) - `./src/stimulus/` — Stimulus controllers - `./src/turbo/` — Turbo integration Where a given module belongs is explained

17k5y agoReviewMountCreate a free account to mount
MODSetterReads credentialsAGENTS.md

SurfSense

MODSetter/SurfSense/AGENTS.md

repair the **same** root link, into `surfsense_local/backend/.venv`, after a FastAPI or Python bump. | | `frontend-workflow` | Frontend work in `www` and `surfsense_local/frontend`: React/Next performance, color tokens, UI polish, motion

17k7d agoReviewMountCreate a free account to mount
MODSetterAGENTS.md

SurfSense / surfsense_local

MODSetter/SurfSense/surfsense_local/AGENTS.md

desktop map. Root `AGENTS.md` owns organization. | Folder | Role | |--------|------| | `backend/` | API and workers (Python) | | `frontend/` | Vite SPA | | `sidecars/` | Boot, the sidecar specs, the supervisor and the watchers both entries run; imports

17k7d agoReviewMountCreate a free account to mount
MODSetterAGENTS.md

SurfSense / www

MODSetter/SurfSense/www/AGENTS.md

vertical slice, one responsibility per file. See root `AGENTS.md`. - React/Next, colors, UI polish, motion: `frontend-workflow` skill. - shadcn components (`components.json`): `shadcn` skill after `frontend-workflow`, not instead of it — separate

17k7d agoReviewMountCreate a free account to mount
umijsAGENTS.md

qiankun

umijs/qiankun/AGENTS.md

Commit:** dcc42ae4 · **Branch:** next (qiankun 3.0, active dev) Qiankun is a micro-frontend framework built on [single-spa](https://github.com/single-spa/single-spa). v3 rewrites the runtime around **streaming HTML-entry loading

17k4mo agoReviewMountCreate a free account to mount
scalarAGENTS.md

scalar

scalar/scalar/AGENTS.md

Turbo for build orchestration, Vite for Vue packages, and `tsc` for pure TypeScript packages - **Frontend**: Vue 3, Composition API, TypeScript - **Styling**: Tailwind CSS - **Testing**: Vitest (unit), Playwright (E2E) - **Linting**: ESLint

16k21d agoReviewMountCreate a free account to mount
apacheDeletes or force-pushesAGENTS.md

doris

apache/doris/AGENTS.md

primarily consists of the Backend module BE (`be/`, execution and storage engine), the Frontend module FE (`fe/`, optimizer and transaction core), and the Cloud module (`cloud/`, storage-compute separation). Your

16k23d agoReviewMountCreate a free account to mount
KanariesAGENTS.md

pygwalker

Kanaries/pygwalker/AGENTS.md

project is put together, how to run it in **dev mode with live frontend reload**, and where all the logs go. Read this first — it is written to save

16k3y agoReviewMountCreate a free account to mount
PCSX2AGENTS.md

pcsx2

PCSX2/pcsx2/AGENTS.md

SPU2, input, storage, networking, and hardware device implementations. - `pcsx2-qt/` - Qt desktop frontend, settings dialogs, debugger, game list, translations, and UI resources. - `common/` - Shared utilities and platform abstraction used throughout

No other project uses it yet

16k2mo 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.