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

iflytekAGENTS.md

skillhub

iflytek/skillhub/AGENTS.md

Reference | Item | Value | |------------|------------------------------------------------------------| | Backend | Spring Boot 3.2.3, Java 21, Maven multi-module (7 modules) | | Frontend | React 19, TypeScript, Vite, pnpm | | Scanner | Python (FastAPI), port 8000 | | Database | PostgreSQL 16 (Flyway migrations

5.2k33d agoDiscuss

clideyAGENTS.md

whodb

clidey/whodb/AGENTS.md

Guide WhoDB is a source-first data management tool. The public GraphQL API and frontend contract are built around `SourceType`, `SourceContract`, `SourceObject`, `SourceObjectRef`, and `SourceSessionMetadata`. The current execution layer

5k6d agoDiscuss

MicrosoftAGENTS.md

poml

microsoft/poml/AGENTS.md

rendering. - **packages/poml-vscode** – VS Code Extension package of POML. - **packages/poml-vscode-webview** – The VS Code Webview frontend JS/TS code. - **python/** – Python SDK and CLI implementation. - **examples/** – Sample POML files. - **docs/** – Project documentation. ## Environment

5k13mo agoDiscuss

Agenta-AIAGENTS.md

agenta

Agenta-AI/agenta/AGENTS.md

instructions are organized](#how-agent-instructions-are-organized) at the bottom. ## Repo map - `web/` — frontend (Next.js, OSS + EE + shared `@agenta/*` packages). See `web/AGENTS.md`. - `api/` — FastAPI backend (OSS + EE + entrypoints

4.8k2mo agoReads credentialsDiscuss

Agenta-AIAGENTS.md

agenta / web

Agenta-AI/agenta/web/AGENTS.md

Frontend conventions Scope: everything under `web/` (`oss`, `ee`, `packages`, `apps`). This file loads when you work in the frontend. The repo-wide root conventions live in `/AGENTS.md`. For deep `@agenta

4.8k2mo agoDiscuss

thunderbirdAGENTS.md

thunderbolt

thunderbird/thunderbolt/AGENTS.md

Handle errors architecturally at higher levels (e.g., error handling middleware). - **Deletes (soft vs hard)** - **Frontend**: Never hard delete. Always soft delete data (set `deletedAt`; call APIs that update rather than

4.8k3mo agoReads credentialsDiscuss

gptmeAGENTS.md

gptme / webui

gptme/gptme/webui/AGENTS.md

agents working on the gptme web UI. ## Dev Setup & Testing Start the backend and frontend dev servers: ```bash # Terminal 1 — backend (from repo root) uv pip install -e ".[server

4.4k4mo agoReads credentialsDiscuss

archestra-aiAGENTS.md

archestra / platform

archestra-ai/archestra/platform/AGENTS.md

loaded it. Load these project skills when the task matches their domain: - `archestra-dev-frontend` - use for frontend Next.js/React work, UI components, forms, TanStack Query hooks, generated API clients

4.3k3d agoReads credentialsDiscuss

EverMind-AIAGENTS.md

Raven

EverMind-AI/Raven/AGENTS.md

trees (`bridge/`, `ui-web/`, `ui-tui/`) are exempt from that extension list: a product frontend carries its own entry HTML and icon SVGs as source, not as report assets. Everything

4.2k3mo agoDeletes or force-pushesDiscuss

dagucloudAGENTS.md

dagu

dagucloud/dagu/AGENTS.md

generated Go server types. - `proto/`: coordinator and index protobuf APIs. - `ui/`: React and TypeScript frontend. - `specs/`: normative behavior specifications. - `conformance/`: binary-level tests for those specifications. - `internal/intg/`: Go integration tests

4.2k5mo agoDiscuss

dagucloudAGENTS.md

dagu / ui

dagucloud/dagu/ui/AGENTS.md

commands unless explicitly asked by the user.** **Before committing:** - Run `make ui` to ensure frontend builds without errors - Use pnpm for frontend package management ## API Development Guidelines ### Remote Node Parameter

4.2k5mo agoDiscuss

kirodotdevAGENTS.md

KiroCrew

kirodotdev/KiroCrew/AGENTS.md

before touching that subsystem: see [Read before you touch](#read-before-you-touch). The frontend has its own router, [`website/AGENTS.md`](website/AGENTS.md). ## What this is Kiro Crew is an open-source

4.2k32d agoReads credentialsDiscuss

kirodotdevAGENTS.md

KiroCrew / website

kirodotdev/KiroCrew/website/AGENTS.md

utility for a token, `src/tailwind-theme.css`, `src/index.css`'s Tailwind header, safe-area utilities | [frontend-conventions § Styling](docs/frontend-conventions.md#styling) | | shared components, a11y, URL sanitization, data fetching, the stack, adding a dependency | [frontend

4.2k32d agoDiscuss

abhi1693AGENTS.md

openclaw-mission-control

abhi1693/openclaw-mission-control/AGENTS.md

backend/tests/`: pytest suite (`test_*.py` naming). - `backend/templates/`: backend-shipped templates used by gateway flows. - `frontend/`: Next.js app. Routes under `frontend/src/app/`, shared components under `frontend/src/components/`, utilities under `frontend/src/lib/`. - `frontend/src/api/generated/`: generated

4.1k7mo agoReads credentialsDiscuss

nyldnAGENTS.md

claude-octopus

nyldn/claude-octopus/AGENTS.md

4.1k48d agoReads credentialsDiscuss

nyldnAGENTS.md

claude-octopus

nyldn/claude-octopus/docs/AGENTS.md

Development Phase](#by-development-phase) - Double Diamond workflow 2. [By Domain](#by-domain) - Backend, Frontend, Quality, Ops 3. [Knowledge Work](#knowledge-work) - Research, consulting, writing 4. [Top 10 Tentacles

4.1k48d agoDiscuss

BenedictKingAGENTS.md

ccx

BenedictKing/ccx/AGENTS.md

服务（Gin），负责路由、认证、调度、协议转换、指标与日志；前端构建产物嵌入到 `backend-go/frontend/dist/`。 - `frontend/`：Vue 3 + Vite + Vuetify 管理界面。 - `dist/`：发布构建产物，禁止手动编辑。 - `.config/`：运行时配置与持久化目录（如 `config.json`、`metrics.db`、`backups/`）。 - `refs/`：外部参考项目存档，仅供对照，默认只读

4k14d agoReads credentialsDiscuss

tutti-osAGENTS.md

tutti / packages

tutti-os/tutti/packages/AGENTS.md

business event protocol contracts and generated transport metadata - `agent/*`: Agent lifecycle Host, canonical store, frontend activity engine, replication contract, and GUI boundaries - `browser/*`: reusable browser/workbench node mechanics for desktop hosts

3.7k4mo agoDiscuss

glitternetworkAGENTS.md

pinme

glitternetwork/pinme/AGENTS.md

published to npm as `pinme`. Users run commands like `pinme upload dist` to deploy frontends. ## Build & Dev ```bash npm run build # Production build (esbuild → dist/index.js) npm run dev # Dev build

3.7k3mo agoReads credentialsDiscuss

memodb-ioAGENTS.md

Acontext / landingpage

memodb-io/Acontext/landingpage/AGENTS.md

noEmit` - Generate import maps after creating or modifying components. ## Project Structure ``` src/ ├── app/ │ ├── (frontend)/ # Frontend routes │ └── (payload)/ # Payload admin routes ├── collections/ # Collection configs ├── globals/ # Global configs ├── components/ # Custom React components

3.7k7mo agoReads credentialsDiscuss

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.