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 19Worked for most · soon
LizardByteAGENTS.md

Sunshine

LizardByte/Sunshine/AGENTS.md

third-party/lizardbyte-common`; inspect the resulting diff for unrelated formatting changes. ## Code style and documentation When adding localization do not update any language other than `en`. This also means

No other project uses it yet

43k5d agoReviewMountCreate a free account to mount
sxyaziAGENTS.md

yazi

sxyazi/yazi/AGENTS.md

related variables, functions, parameters, modules, methods, types, derived types, exports, tests, configuration keys, documentation, Lua bindings, and, when a type and file share a name, the file as well

No other project uses it yet

43k6mo agoReviewMountCreate a free account to mount
deepspeedaiAGENTS.md

DeepSpeed

deepspeedai/DeepSpeed/AGENTS.md

mechanics that the code already shows. - New features must include corresponding tests and documentation updates. - All changes must not cause `import deepspeed` to initialize CUDA; Keep heavy imports

No other project uses it yet

43k12d agoReviewMountCreate a free account to mount
duckdbAGENTS.md

duckdb

duckdb/duckdb/AGENTS.md

bindings - Function registration - Settings - Serialization code - Storage info - Metric enums - Enum utilities ## Documentation - Main docs: https://duckdb.org/docs/ - Development docs: https://duckdb.org/dev/ - Build guide: https://duckdb.org/docs/dev/building/overview - Testing docs

Steady4 mentions in 2 weeks

No other project uses it yet

43k6mo agoReviewMountCreate a free account to mount
tinyhumansaiReads credentialsAGENTS.md

openhuman

tinyhumansai/openhuman/AGENTS.md

host::tui` | | `tests/` | Rust integration and JSON-RPC tests | | `docs/gitbooks/` | Public product and contributor documentation, synced with GitBook (`en/` is canonical, `zh/` the translation) | | `docs/` | Everything else here is internal

No other project uses it yet

43k33d agoReviewMountCreate a free account to mount
wshobsonAGENTS.md

agents

wshobson/agents/docs/agents.md

spark-ops-engineer](../plugins/dgx-spark-ops/agents/dgx-spark-ops-engineer.md) | sonnet | DGX Spark (GB10/aarch64/CUDA 13) environment setup and diagnostics | ### Documentation & Technical Writing | Agent | Model | Description | | ------------------------------------------------------------------------------------ | ------ | --------------------------------------------------------------------- | | [docs-architect](../plugins/code-documentation/agents/docs-architect.md) | opus | Comprehensive technical documentation generation | | [api-documenter](../plugins/api-testing-observability/agents/api-documenter.md

No other project uses it yet

43k32d agoReviewMountCreate a free account to mount
fastlaneAGENTS.md

fastlane

fastlane/fastlane/AGENTS.md

fastlane lint_source`: RuboCop and other source checks - `bundle exec fastlane validate_docs`: action documentation and how tools are named in Markdown ## Guides Read the guides for the files

No other project uses it yet

42k41d agoReviewMountCreate a free account to mount
lfnovoAGENTS.md

open-notebook / frontend

lfnovo/open-notebook/frontend/AGENTS.md

precise only when it matters. - Dark mode requires the `dark` class on the document root, not just `prefers-color-scheme`. It's hand-rolled: the zustand `theme-store` (persisted

No other project uses it yet

42k3d agoReviewMountCreate a free account to mount
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

No other project uses it yet

42k2y agoReviewMountCreate a free account to mount
apacheAGENTS.md

dubbo

apache/dubbo/AGENTS.md

will be closed citing the threat model - Matches a known non-finding (§11a) — already documented as a false positive ## For automated security tools The threat model includes a machine-readable

No other project uses it yet

42k3y 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
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

41k2d agoReviewMountCreate a free account to mount
ToolJetReads credentialsAGENTS.md

ToolJet

ToolJet/ToolJet/AGENTS.md

repository is public; `server/ee/` and `frontend/ee/` are separate private submodules. For public issues, PRs, documentation, and support responses: - Base claims and reproduction steps only on public-repository evidence

Steady7 mentions in 2 weeks

No other project uses it yet

41k4d agoReviewMountCreate a free account to mount
ToolJetReads credentialsAGENTS.md

ToolJet / server

ToolJet/ToolJet/server/AGENTS.md

bypass only defers the same failure to CI. ## Testing (Jest) > Tests are documentation first. Describe blocks = table of contents; `it()` = plain English; assertions = response shape. Write failing tests before implementation

Steady7 mentions in 2 weeks

No other project uses it yet

41k4d agoReviewMountCreate a free account to mount
HmbownAGENTS.md

DeepSeek-TUI / web

Hmbown/DeepSeek-TUI/web/AGENTS.md

MESSAGING.md`: it needs a new decision and names the proof it retires. - `AGENT.md` (singular) documents maintainer-owned community automation. Do not expand its authority without Hunter. Choose evidence according

No other project uses it yet

41k6d 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 └── .github/scripts/ # Build, validation, and repository automation scripts grouped by purpose ``` ## Setup

41k21d 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

41k42d 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

41k13d 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
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

Steady16 mentions in 2 weeks

No other project uses it yet

41k3mo 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.