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 11Worked for most · soon
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

16k20d 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

16k59d agoReviewMountCreate a free account to mount
facebookAGENTS.md

infer

facebook/infer/AGENTS.md

pattern `{lang}_{analyzer}`, e.g., `direct_java_pulse_test`, `direct_cpp_pulse_test`, `direct_c_frontend_test`. These are defined in the `DIRECT_TESTS` variable in the root Makefile. ### Test structure

16k27d agoReviewMountCreate a free account to mount
open-metadataAGENTS.md

OpenMetadata

open-metadata/OpenMetadata/AGENTS.md

discovery, observability, and governance — a multi-module project with a Java backend, a React/TypeScript frontend, a Python ingestion framework, and Docker infrastructure. ## Stack at a glance - **Backend**: Java 21 + Dropwizard

16k22d agoReviewMountCreate a free account to mount
documensoAGENTS.md

documenso

documenso/documenso/AGENTS.md

Handling & Validation - Use custom AppError class when throwing errors - When catching errors on the frontend use `const error = AppError.parse(error)` to get the error code - Use early returns and guard

16k10mo agoReviewMountCreate a free account to mount
zitadelAGENTS.md

zitadel

zitadel/zitadel/AGENTS.md

separate table for history/audit, but events are not the system of record. - **Frontend**: - **Console**: Angular + RxJS. - **Login/Docs**: Next.js + React. ## ZITADEL Domain & Multi-Tenancy Logic ### 1. Hierarchy & Ownership ZITADEL follows

15k4mo agoReviewMountCreate a free account to mount
zitadelAGENTS.md

zitadel / packages

zitadel/zitadel/packages/AGENTS.md

ZITADEL Packages Guide for AI Agents ## Context `packages/` contains shared TypeScript libraries used by frontend applications and external consumers. ## Main Packages - **`packages/zitadel-proto`** (`@zitadel/proto`): generated protobuf TypeScript artifacts. - **`packages/zitadel-client`** (`@zitadel/client`): higher

15k4mo agoReviewMountCreate a free account to mount
jupyterlabAGENTS.md

jupyterlab

jupyterlab/jupyterlab/AGENTS.md

disposables) - **Extension plugin examples**: `packages/*-extension/src/index.ts` - **TypeScript Style Guide**: https://github.com/jupyterlab/jupyterlab/wiki/TypeScript-Style-Guide ## Technology Stack - Frontend: TypeScript, React 18, Lumino (widgets), CodeMirror 6 - Backend: Python, Jupyter Server, Tornado, Traitlets - Build: Rspack

15k5mo agoReviewMountCreate a free account to mount
ChocobozzzAGENTS.md

PeerTube

Chocobozzz/PeerTube/AGENTS.md

distributed runners. ## Repository Structure - **apps/** — Standalone CLI applications (`peertube-cli`, `peertube-runner`) - **client/** — Angular frontend SPA (separate build system) - **config/** — YAML configuration files for dev, test, and production - **packages/** — Shared

15k3mo agoReviewMountCreate a free account to mount
ChocobozzzAGENTS.md

PeerTube / client

Chocobozzz/PeerTube/client/AGENTS.md

Client — Angular Frontend SPA PeerTube's web client is an Angular single-page application served under `/client/`. It communicates with the backend exclusively through the REST API (`/api/v1/`). A separate

No other project uses it yet

15k3mo agoReviewMountCreate a free account to mount
caproverAGENTS.md

caprover

caprover/caprover/AGENTS.md

data contracts. - `src/utils/CaptainConstants.ts`: runtime configuration, identifiers, and filesystem paths. - `tests/`: Jest regression tests. The frontend is maintained in `caprover/caprover-frontend`. User-facing documentation is maintained in `caprover/caprover-website`. ## Change constraints - Preserve

Steady3 mentions in 2 weeks

No other project uses it yet

15k5y agoReviewMountCreate a free account to mount
alexta69AGENTS.md

metube

alexta69/metube/AGENTS.md

wiki. ## Tech stack - **Backend:** Python 3.13+, aiohttp, python-socketio 5.x, yt-dlp - **Frontend:** Angular 22, TypeScript, Bootstrap 5, SASS, ngx-socket-io - **Package managers:** uv (Python), pnpm (frontend) - **Container

15k37d agoReviewMountCreate a free account to mount
grokabilityReads credentialsAGENTS.md

snipe-it

grokability/snipe-it/AGENTS.md

table, $item_id = null)` — post-checkout redirect logic. === .ai/snipe-it-stack rules === # Snipe-IT Stack & Tooling ## Frontend Is Laravel Mix, Not Vite - Assets are built with **Laravel Mix (webpack)** via `webpack.mix.js`. This

Steady15 mentions in 2 weeks

No other project uses it yet

15k13mo agoReviewMountCreate a free account to mount
yusufkaraaslanReads credentialsAGENTS.md

Skill_Seekers

yusufkaraaslan/Skill_Seekers/AGENTS.md

server are unaffected. Local web app: React 19 + Vite + Tailwind/shadcn frontend in `ui/`, FastAPI backend in `src/skill_seekers/web/`. ```bash # Run the app (opens browser; API on :8770) skill-seekers ui # Frontend

15k13mo agoReviewMountCreate a free account to mount
bytebaseAGENTS.md

bytebase

bytebase/bytebase/AGENTS.md

around it. ## Read before working - Before exploring domain behavior, read [domain guidance](docs/agents/domain.md). - For frontend work, read [frontend/AGENTS.md](frontend/AGENTS.md); before changing UI, also read the [UX contract](docs/agents/frontend-ux.md). - Before adding

15k5d agoReviewMountCreate a free account to mount
bytebaseAGENTS.md

bytebase / frontend

bytebase/bytebase/frontend/AGENTS.md

under `./frontend/`. ## Inheritance - Follow the repository-wide guidance in `../AGENTS.md`. - Treat this file as frontend-specific additions, not a replacement for the root instructions. ## React - All product UI code

15k5d agoReviewMountCreate a free account to mount
QloappsDeletes or force-pushesAGENTS.md

QloApps

Qloapps/QloApps/AGENTS.md

code generation. ## Technology Stack - **Language:** PHP 8.2–8.5 (backend), Smarty 3.x (templates), JavaScript/jQuery (frontend) - **Database:** MySQL 5.7, 8.0+; MariaDB 10.5, 10.6, 10.11, 11.0, 11.2, 11.4 - **Architecture:** MVC with hook

14k6d agoReviewMountCreate a free account to mount
siteboonAGENTS.md

claudecodeui

siteboon/claudecodeui/AGENTS.md

Apply it only to backend code; do not impose those architecture rules on the frontend. ## Frontend code For every task that creates, modifies, refactors, or reviews frontend code under

No other project uses it yet

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