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 13Worked for most · soon
datahub-projectReads credentialsAGENTS.md

datahub

datahub-project/datahub/AGENTS.md

Core Services - **GMS (Generalized Metadata Service)**: Java/Spring backend handling metadata storage and REST/GraphQL APIs - **Frontend**: React/TypeScript application consuming GraphQL APIs - **Ingestion Framework**: Python CLI and connectors for extracting metadata from

13k2mo agoReviewMountCreate a free account to mount
datahub-projectAGENTS.md

datahub / datahub-web-react

datahub-project/datahub/datahub-web-react/AGENTS.md

Development Commands From the **repo root**: ```bash # Hot-reload dev server (preferred) scripts/dev/datahub-dev.sh setup frontend # one-time setup scripts/dev/datahub-dev.sh frontend # dev server with hot reload ``` From **`datahub-web-react/`**: ```bash

13k2mo agoReviewMountCreate a free account to mount
NVIDIAAGENTS.md

auto-ontology

NVIDIA/auto-ontology/AGENTS.md

partners embedding it in an agent harness. Auto-Ontology **maintainers** (build, test, schema, frontend conventions) stay on [`CLAUDE.md`](./CLAUDE.md). Do not fold those conventions into these skills. ## Which skill

13k46d agoReviewMountCreate a free account to mount
nearaiReads credentialsAGENTS.md

ironclaw

nearai/ironclaw/AGENTS.md

assistant` owns product-facing orchestration and `ProductSurface`; composition wires dependencies; WebUI owns HTTP/transport and frontend presentation. - Provider-neutral model contracts and provider implementations belong in `ironclaw_llm`; wrappers delegate

13k3mo agoReviewMountCreate a free account to mount
TwiNAGENTS.md

gatus

TwiN/gatus/AGENTS.md

make test` — Run all Go tests with coverage - `make clean` — Remove built binary - `make frontend-install` — Install frontend npm dependencies - `make frontend-build` — Build the Vue.js frontend (**must run after

No other project uses it yet

13k12mo agoReviewMountCreate a free account to mount
ChainlitAGENTS.md

chainlit

Chainlit/chainlit/AGENTS.md

production-ready conversational AI applications. It consists of a Python/FastAPI backend and a React frontend, with a pnpm monorepo for the JS packages. ## Prerequisites - Python: **3.13** (3.10+ is the framework

13k16mo agoReviewMountCreate a free account to mount
jason5ng32AGENTS.md

MyIP

jason5ng32/MyIP/AGENTS.md

Express 5 back-end API. Licensed under AGPL-3.0-only (`LICENSE`). ## Stack | Layer | Technology | |---|---| | Frontend

Steady3 mentions in 2 weeks

No other project uses it yet

12k3mo agoReviewMountCreate a free account to mount
jason5ng32AGENTS.md

MyIP / api

jason5ng32/MyIP/api/AGENTS.md

offline dataset engine and its readers (see "Offline datasets"). - **`common/`** — only what the frontend or the build imports too (`valid-ip.js`, `fetch-with-timeout.js`, `report-schema.js`, …); it never imports from `server/`. It also holds

Steady3 mentions in 2 weeks

No other project uses it yet

12k3mo agoReviewMountCreate a free account to mount
jason5ng32AGENTS.md

MyIP / frontend

jason5ng32/MyIP/frontend/AGENTS.md

frontend/AGENTS.md Conventions specific to the Vue 3 SPA under `frontend/`. Universal rules (language, i18n, commits, testing) live in ../AGENTS.md. ## Overview

Steady3 mentions in 2 weeks

No other project uses it yet

12k3mo agoReviewMountCreate a free account to mount
dataelementDeletes or force-pushesAGENTS.md

bisheng

dataelement/bisheng/AGENTS.md

docs/architecture/01-architecture-overview.md`): - Two SPAs — platform (:3001) and client (:4001, base `/workspace`) — call FastAPI (:7860): `/api/v1` frontend-facing, `/api/v2` open RPC. Commercial edition inserts a Java gateway in front (→ `architecture/11-gateway.md`). - Async work

Steady2 mentions in 2 weeks

No other project uses it yet

12k5mo agoReviewMountCreate a free account to mount
Arize-aiAGENTS.md

phoenix

Arize-ai/phoenix/AGENTS.md

references that apply: | Area | Skills | References reviewers cite most | | --- | --- | --- | | Any TypeScript | `phoenix-typescript` | | | Frontend (`js/app/`) | `phoenix-frontend`, `phoenix-design` | `phoenix-frontend/references/testing.md`, `accessibility.md`, `components.md`; `phoenix-design/references/error-display.md` | | Storybook (`js/app/stories/`) | `phoenix

12k2mo agoReviewMountCreate a free account to mount
StarRocksAGENTS.md

starrocks

StarRocks/starrocks/AGENTS.md

nested `AGENTS.md`. 3. For Backend work, read [`handbook/domains/backend.md`](./handbook/domains/backend.md) and [`be/AGENTS.md`](./be/AGENTS.md). 4. For Frontend work, read [`handbook/domains/frontend.md`](./handbook/domains/frontend.md) and [`fe/AGENTS.md`](./fe/AGENTS.md). 5. For SQL tests, docs, generated code, Java

Steady2 mentions in 2 weeks

No other project uses it yet

12k4d agoReviewMountCreate a free account to mount
StarRocksDeletes or force-pushesAGENTS.md

starrocks / fe

StarRocks/starrocks/fe/AGENTS.md

AGENTS.md - StarRocks Frontend (FE) > Frontend-specific guidelines for AI coding agents. > The FE is written in Java and handles SQL parsing, query optimization, and metadata management. ## Architecture Overview Start with

Steady2 mentions in 2 weeks

No other project uses it yet

12k4d agoReviewMountCreate a free account to mount
viarotel-orgAGENTS.md

escrcpy

viarotel-org/escrcpy/AGENTS.md

pnpm build` for packaging, Electron main-process, Vite config, dependency, or release-sensitive changes. ## Frontend Patterns - Vue code uses Vue 3 Composition API with

12k14mo agoReviewMountCreate a free account to mount
mesheryReads credentialsAGENTS.md

meshery

meshery/meshery/AGENTS.md

Structure | Directory | Purpose | |-----------|---------| | `/server` | Go backend — REST/GraphQL APIs, Kubernetes management, PostgreSQL | | `/ui` | Next.js/React frontend — MUI, Redux Toolkit, Relay GraphQL | | `/mesheryctl` | Go CLI with Cobra — install, lifecycle, pattern deployment | | `/docs

No other project uses it yet

12k3mo agoReviewMountCreate a free account to mount
aureuserpAGENTS.md

aureuserp

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

12k6mo agoReviewMountCreate a free account to mount
dreamhunter2333AGENTS.md

cloudflare_temp_email

dreamhunter2333/cloudflare_temp_email/AGENTS.md

Backend**: `worker/` — Cloudflare Workers API using Hono framework. Entry: `worker/src/worker.ts`, APIs under `worker/src/*_api/`. - **Frontend**: `frontend/` — Vue 3 + Naive UI app deployed to Cloudflare Pages. Routes in `frontend/src/router/`. - **Pages middleware

12k31d agoReviewMountCreate a free account to mount
OpenRefineAGENTS.md

OpenRefine

OpenRefine/OpenRefine/AGENTS.md

Java Version**: JDK 26 - **Build Tool**: Apache Maven - **Project Structure**: Multi-module Maven project ### Frontend - **JavaScript Libraries**: jQuery, jQuery UI, Select2, Underscore.js - **Internationalization**: @wikimedia/jquery.i18n - **Build/Package Management**: Node.js

No other project uses it yet

12k21d agoReviewMountCreate a free account to mount
chthollyphileReads credentialsAGENTS.md

folia-major

chthollyphile/folia-major/AGENTS.md

改代码、测试、流程或文档前,从仓库内 README 中取仍然有效的上下文,并核对它。 - `glossary-alignment`:把口头说的组件、视图、状态、面板、模式等说法换成可检索的符号名或模块名。 - `frontend-runtime-guardrails`:高频动画、`useMotionValueEvent`、`requestAnimationFrame`、`ResizeObserver` 和 React state 更新频率的约束,避免 visualizer 等路径引入高 CPU 或时序错位

Steady13 mentions in 2 weeks

No other project uses it yet

12k4mo agoReviewMountCreate a free account to mount
TencentCloudAGENTS.md

Octop

TencentCloud/Octop/AGENTS.md

Agent runtime | `octop-harness` | | IM channels | `octop-gateway` | | Memory | `octop-memory` | | Browser | `octop-browser` | | Frontend | React 18 + TypeScript + Vite | | Package manager | uv — always `uv run pytest`, never bare `pytest

12k13d 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.