agentleFS

AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Worked for most · soon
yaklangAGENTS.md

yakit

yaklang/yakit/AGENTS.md

本文件为所有 AI Agent(及新开发者)提供项目启动所需的背景知识。 阅读本文件后,你应能独立完成依赖安装与本地开发环境的启动。 Yakit 是一个基于 Electron + React 的跨平台桌面应用,主要技术栈包括 Electron、React、TypeScript 等。项目通过 Vite 构建渲染端,使用 Yarn 作为包管理器。 主进程在开发模式下会分别加载: - 主窗口:http://127.0.0.1:3000(app/main/index.js:247) - 引擎链接窗口:http://127.0.0.1:5173(app/main/index.js:143) 因此*两个渲染端都必须成功启动后,才能启动 Electron 主进程*,否则窗口会白屏。 项目共有三个需要安装依赖的子项目。一条命令即可按顺序全部安装(根目录 → Link 渲染端 → 主渲染端):

No other project uses it yet

7.9k14d 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.