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
qbittorrentAGENTS.md

qBittorrent

qbittorrent/qBittorrent/AGENTS.md

assistance, but a human must review, take responsibility for, and submit the final changes. ## Document Purpose This document provides policy and guidelines for AI operations. \ Do not expect this file

Steady2 mentions in 2 weeks

No other project uses it yet

41k2y agoReviewMountCreate a free account to mount
outlineAGENTS.md

outline

outline/outline/AGENTS.md

config files** - TypeScript, Vite, Vitest, oxfmt, Oxlint configurations Refer to /docs/ARCHITECTURE.md for detailed architecture documentation. ## Instructions You're an expert in the following areas: - TypeScript - React and React Router - MobX

No other project uses it yet

41k24d agoReviewMountCreate a free account to mount
vimAGENTS.md

vim

vim/vim/AGENTS.md

script files named `test_*.vim`. Screendump expected output lives in `src/testdir/dumps/`. - `runtime/doc/` - user-facing documentation in Vim help format, when updating, also update the Last Change header - `runtime/syntax/generator` - Syntax script

No other project uses it yet

41k9mo agoReviewMountCreate a free account to mount
HmbownAGENTS.md

CodeWhale / web

Hmbown/CodeWhale/web/AGENTS.md

truthful state until the complete asset set passes manifest tests. - `AGENT.md` (singular) documents maintainer-owned community automation. Do not expand its authority without Hunter. Choose evidence according to the claim

2 projects use a version of this

41k41d agoReviewMountCreate a free account to mount
nushellAGENTS.md

nushell

nushell/nushell/AGENTS.md

without adding a pile of new helpers: reuse the helpers that already exist. Document new code. - Don't run `cargo clean`; it forces a full recompile on the next build

Steady3 mentions in 2 weeks

No other project uses it yet

41k14mo agoReviewMountCreate a free account to mount
vuetifyjsAGENTS.md

vuetify

vuetifyjs/vuetify/AGENTS.md

vuetify` npm package - `packages/api-generator` — builds API data (props, events, slots, descriptions) for docs - `packages/docs` — documentation site Contributor guide: `packages/docs/src/pages/en/getting-started/contributing.md` Supported browsers: `packages/docs/src/pages/en/getting-started/browser-support.md` ## Branches | Base | For | Docs | |----------|-------------------------------------------------------|--------------------| | `master` | safe bug fixes

No other project uses it yet

41k12d agoReviewMountCreate a free account to mount
GitHubAGENTS.md

awesome-copilot

github/awesome-copilot/AGENTS.md

plugin packages (folders with plugin.json) ├── extensions/ # Reusable canvas extension sources (extension.mjs and assets) ├── docs/ # Documentation for different resource types ├── eng/ # Build and automation scripts └── scripts/ # Utility scripts ``` ## Setup Commands ```bash

No other project uses it yet

41k20d agoReviewMountCreate a free account to mount
schollzAGENTS.md

croc

schollz/croc/AGENTS.md

workflow. GitHub Actions and release operations continue to use the GitHub CLI (`gh`) as documented below. ## Releasing croc Releases are prepared by the **Prepare Release** GitHub Actions workflow

Steady23 mentions in 2 weeks

No other project uses it yet

41k3mo agoReviewMountCreate a free account to mount
pingcapAGENTS.md

tidb

pingcap/tidb/AGENTS.md

format: `PLANS.md` at repository root. - Requirement: keep the ExecPlan updated as a living document while implementation progresses. - Scope: use this for multi-step work where losing context would risk correctness

No other project uses it yet

41k2mo agoReviewMountCreate a free account to mount
Yeachan-HeoAGENTS.md

oh-my-claude-sisyphus

Yeachan-Heo/oh-my-claude-sisyphus/AGENTS.md

agent). - Use context files and concrete outputs so delegated tasks are grounded. - Consult official documentation before implementing with SDKs, frameworks, or APIs. - For cleanup or refactor work, write a cleanup

1 project uses a version of this

41k7d agoReviewMountCreate a free account to mount
Yeachan-HeoAGENTS.md

oh-my-claude-sisyphus

Yeachan-Heo/oh-my-claude-sisyphus/docs/AGENTS.md

docs User documentation and technical guides for oh-my-claudecode. ## Purpose This directory contains documentation for end-users and developers: - **End-user guides**: How to use oh-my-claudecode features

2 projects use a version of this

41k7d agoReviewMountCreate a free account to mount
Yeachan-HeoAGENTS.md

oh-my-claude-sisyphus / skills

Yeachan-Heo/oh-my-claude-sisyphus/skills/AGENTS.md

open question and return grounded, sourced findings | | `external-context/SKILL.md` | external-context | Invoke parallel document-specialist agents for external web searches and documentation lookup | | `autoresearch/SKILL.md` | autoresearch | Stateful single-mission improvement

No other project uses it yet

41k7d agoReviewMountCreate a free account to mount
Yeachan-HeoAGENTS.md

oh-my-claude-sisyphus / src

Yeachan-Heo/oh-my-claude-sisyphus/src/AGENTS.md

Create feature directory in `features/` 2. Export from `features/index.ts` 3. Update `docs/FEATURES.md` with API documentation #### TypeScript Conventions - Use strict mode (`noImplicitAny`, `strictNullChecks`) - Prefer interfaces over type aliases for public APIs

2 projects use a version of this

41k7d agoReviewMountCreate a free account to mount
Yeachan-HeoAGENTS.md

oh-my-claudecode / skills

Yeachan-Heo/oh-my-claudecode/skills/AGENTS.md

open question and return grounded, sourced findings | | `external-context/SKILL.md` | external-context | Invoke parallel document-specialist agents for external web searches and documentation lookup | | `autoresearch/SKILL.md` | autoresearch | Stateful single-mission improvement

Steady16 mentions in 2 weeks

No other project uses it yet

41k7d agoReviewMountCreate a free account to mount
photoprismAGENTS.md

photoprism / frontend

photoprism/photoprism/frontend/AGENTS.md

Full rules: `specs/frontend/translations.md` §"Case Conventions". ## Focus Management - Dialogs must follow the shared focus pattern documented in `frontend/src/common/README.md`. - Always expose `ref="dialog"` on ` ` overlays, call `$view.enter` and `$view.leave` in `@after-enter

Steady2 mentions in 2 weeks

No other project uses it yet

40k3mo agoReviewMountCreate a free account to mount
PostHogAGENTS.md

posthog

PostHog/posthog/AGENTS.md

titles. - When a change touches user-facing behavior, an API, a config/setting, or a documented workflow, update an existing doc under `docs/` **whose scope covers that behavior** in the same

No other project uses it yet

40k26d agoReviewMountCreate a free account to mount
gofiberAGENTS.md

fiber

gofiber/fiber/AGENTS.md

surrounding code. - Keep all protocol behavior RFC-compliant (e.g., HTTP/1.1 requirements) and document any intentional deviations. - Protect hot paths from regressions: profile changes. - Apply secure-by-default choices (validation, timeouts

40k8d agoReviewMountCreate a free account to mount
videojsAGENTS.md

video.js

videojs/video.js/AGENTS.md

apps/sandbox`: Vite playground. `templates/` is tracked; `src/` is scratch. - `apps/e2e`: Playwright coverage. - `site`: Astro documentation site; follow `site/AGENTS.md`. Keep framework-neutral packages free of DOM or framework dependencies. Put platform

Steady19 mentions in 2 weeks

No other project uses it yet

40k10d agoReviewMountCreate a free account to mount
videojsAGENTS.md

video.js / site

videojs/video.js/site/AGENTS.md

React context. - React Compiler is enabled; do not add memoization without a measured or documented need. ## Content - Read `src/content/docs/writing-style/write-guides.mdx` before adding or reviewing site prose. It owns document types, frontmatter

Steady19 mentions in 2 weeks

No other project uses it yet

40k10d agoReviewMountCreate a free account to mount
DioxusLabsAGENTS.md

dioxus

DioxusLabs/dioxus/AGENTS.md

communication protocol ├── interpreter/ # Sledgehammer JS for DOM mutations └── wasm-split/ # WASM code splitting ``` ## Architecture Documentation For deeper understanding, see `notes/architecture/`: | When working on... | Read... | | ------------------------------------------ | ------------------ | | VirtualDOM, components, diffing, events | `01-CORE.md

40k10mo 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.