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 5Worked for most · soon
photoprismReads credentialsAGENTS.md

photoprism

photoprism/photoprism/AGENTS.md

/developer-guide/api/ - Code maps: [`CODEMAP.md`](CODEMAP.md), [`frontend/CODEMAP.md`](frontend/CODEMAP.md) - Package docs: `README.md` files under `internal/`, `pkg/`, `frontend/`, and `frontend/src/` - Frontend dependency pins, override layer, and orphan-audit pattern: [`frontend/README.md`](frontend/README.md) (read before

40k3mo agoReviewMountCreate a free account to mount
photoprismAGENTS.md

photoprism / frontend

photoprism/photoprism/frontend/AGENTS.md

Frontend Guidelines **Last Updated:** October 29, 2026 ## Dependencies & Pins - [`frontend/README.md`](README.md) is the canonical doc for dependency pin rationale, the `overrides` layer, ESM-only upgrade blockers, and the orphan-audit

40k3mo agoReviewMountCreate a free account to mount
PostHogAGENTS.md

posthog

PostHog/posthog/AGENTS.md

Changed files only: `hogli test --changed` - Lint: - Python: - `ruff check . --fix` and `ruff format .` - Frontend: `pnpm --filter=@posthog/frontend fix` (safe Oxlint fixes + Oxfmt; suggestion fixes are not applied). `format` runs

1 project uses a version of this

40k12d agoReviewMountCreate a free account to mount
HKUDSReads credentialsAGENTS.md

LightRAG

HKUDS/LightRAG/AGENTS.md

Drop `-n` when you need `pdb`/`-s` or ordered output. - Backend tests use pytest; frontend unit tests use Bun's built-in runner — see *WebUI* above and *React component tests

Steady9 mentions in 2 weeks

No other project uses it yet

40k5mo agoReviewMountCreate a free account to mount
halo-devAGENTS.md

halo

halo-dev/halo/AGENTS.md

monorepo: Java 21 / Spring Boot WebFlux + R2DBC backend and a Vue 3 + TypeScript + TailwindCSS frontend. Work from the repo root and load **every relevant module guide** for the areas

No other project uses it yet

40k4mo agoReviewMountCreate a free account to mount
halo-devAGENTS.md

halo / ui

halo-dev/halo/ui/AGENTS.md

Frontend Guidelines `ui/` is the Vue 3 + TypeScript + TailwindCSS frontend, managed with pnpm workspaces. ## Structure - `ui/console-src/` — console application (entry: `console.html`, alias `@console`). - `ui/uc-src/` — user center application (entry: `uc.html`, alias

40k4mo agoReviewMountCreate a free account to mount
lfnovoReads credentialsAGENTS.md

open-notebook

lfnovo/open-notebook/AGENTS.md

read it on demand instead of guessing. ## Stack, ports, startup order Three tiers: Next.js frontend (3000) → FastAPI (5055) → SurrealDB (8000). Start in this order — each tier depends

No other project uses it yet

40k2mo agoReviewMountCreate a free account to mount
lfnovoAGENTS.md

open-notebook / frontend

lfnovo/open-notebook/frontend/AGENTS.md

Frontend Rules (frontend/) Normative rules for working on the Next.js frontend. Architecture and flow walkthroughs live in [docs/7-DEVELOPMENT/frontend.md](../docs/7-DEVELOPMENT/frontend.md) — this file is only what you must know before changing code

No other project uses it yet

40k2mo agoReviewMountCreate a free account to mount
lfnovoAGENTS.md

open-notebook / open_notebook

lfnovo/open-notebook/open_notebook/AGENTS.md

Follow the [Add an AI provider](../docs/7-DEVELOPMENT/change-playbooks.md#playbook-add-an-ai-provider) playbook. The frontend consumes `GET /api/providers` at runtime (`useProviders()`), so a simple API-key provider needs no frontend

No other project uses it yet

40k2mo agoReviewMountCreate a free account to mount
spacedriveappAGENTS.md

spacedrive

spacedriveapp/spacedrive/AGENTS.md

using `register_*` macros - Blocking the async runtime with synchronous I/O operations ### Quick tips - On frontend apps, such as the interface in React, you must ALWAYS ensure type-safety based

No other project uses it yet

39k25d agoReviewMountCreate a free account to mount
CopilotKitAGENTS.md

CopilotKit

CopilotKit/CopilotKit/AGENTS.md

negotiable iron rules for showcase cells. # CopilotKit AI agent framework with three layers: **Frontend** (React/Angular/Vanilla) → **Runtime** (Express/Hono) → **Agent** (LangGraph/CrewAI/BuiltIn/Custom), communicating via the AG-UI protocol (event-based SSE). ## Essentials

Steady3 mentions in 2 weeks

No other project uses it yet

38k3d agoReviewMountCreate a free account to mount
CopilotKitAGENTS.md

CopilotKit / showcase

CopilotKit/CopilotKit/showcase/AGENTS.md

Showcase — Agent Guidance (canonical) > **BEFORE touching ANY showcase cell (integration, test, fixture, frontend), these are non-negotiable.** > > These rules have been re-explained ~20 times because they were written down

No other project uses it yet

38k3d agoReviewMountCreate a free account to mount
AdguardTeamReads credentialsAGENTS.md

AdGuardHome / client_v2

AdguardTeam/AdGuardHome/client_v2/AGENTS.md

AGENTS.md — AdGuard Home client_v2 (SolidJS Frontend) ## Table of Contents - [AGENTS.md — AdGuard Home client_v2 (SolidJS Frontend)](#agentsmd--adguard-home-client_v2-solidjs-frontend) - [Table of Contents](#table-of-contents

Steady5 mentions in 2 weeks

No other project uses it yet

38k2mo agoReviewMountCreate a free account to mount
blakeblackshearAGENTS.md

frigate

blakeblackshear/frigate/AGENTS.md

detection system for IP cameras that uses: - **Backend**: Python 3.13+ with FastAPI, OpenCV, TensorFlow/ONNX - **Frontend**: React with TypeScript, Vite, TailwindCSS - **Architecture**: Multiprocessing design with ZMQ and MQTT communication - **Focus**: Minimal

37k12mo agoReviewMountCreate a free account to mount
medusajsReads credentialsAGENTS.md

medusa

medusajs/medusa/AGENTS.md

payment, fulfillment, file, auth, notification, ...) | `src/modules/ ` | `packages/modules/providers/*` as reference implementations | | Storefront / client calls | separate frontend | `packages/core/js-sdk` | - Applications import from `@medusajs/framework/*` (e.g. `@medusajs/framework/utils`, `/http`, `/workflows-sdk`, `/types`) and `@medusajs/medusa/*`, not from internal

37k10mo agoReviewMountCreate a free account to mount
wailsappAGENTS.md

wails

wailsapp/wails/AGENTS.md

desired - Preserves planning history for archeological research - Reduces noise when browsing the project ## Frontend Runtime: Two Build Outputs The TypeScript runtime in `v3/internal/runtime/desktop/@wailsio/runtime` produces **two** independent artifacts, and rebuilding

37k6d agoReviewMountCreate a free account to mount
wailsappAGENTS.md

wails / v3

wailsapp/wails/v3/AGENTS.md

module. It contains the public application APIs, `wails3` CLI, platform implementations, generators, frontend runtime sources and bundles, templates, examples, tests, and v3-specific release tooling. Its module is defined

37k6d agoReviewMountCreate a free account to mount
langfuseReads credentialsAGENTS.md

langfuse

langfuse/langfuse/.agents/AGENTS.md

data. Prefer read-only queries, and continue to use the seed CLI to create frontend test state rather than ad-hoc inserts. - Dev Docker Compose exposes these clients on `${HOST

37k1d agoReviewMountCreate a free account to mount
langfuseReads credentialsAGENTS.md

langfuse / web

langfuse/langfuse/web/AGENTS.md

current Next.js, React, and tRPC versions before version-sensitive work. - Primary package for frontend and most request/response surface changes. ## Maintenance Contract - Update this file in the same PR when entry

37k1d agoReviewMountCreate a free account to mount
langfuseAGENTS.md

langfuse / worker

langfuse/langfuse/worker/AGENTS.md

langfuse/shared` for cross-runtime types, schemas, domain contracts, model-pricing helpers, and other frontend-safe utilities. - Use `@langfuse/shared/src/db` only when worker code or tests need direct Prisma access. - Use narrower

37k1d 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.