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 7Worked for most · soon
immich-appAGENTS.md

immich / native

immich-app/immich/native/AGENTS.md

abort"`. - When a crate dependency changes, update `native_core/NOTICES` with its license. ## Skills - **Build, test and lint**: `mise //native:build`, `mise //native:test`, `mise //native:lint`, `mise //native

118k12d agoReviewMountCreate a free account to mount
immich-appAGENTS.md

immich / server

immich-app/immich/server/AGENTS.md

docs/docs/developer/architecture.mdx`. ## Rules - ESM with no relative imports (lint-enforced). Import as `src/...js` and `test/...js`. - Every route has `@Authenticated(...)` and `@Endpoint({ summary, description, history })`; the global `AuthGuard` throws otherwise

118k12d agoReviewMountCreate a free account to mount
immich-appAGENTS.md

immich / web

immich-app/immich/web/AGENTS.md

explicit `.ts` extension: `import { authManager } from '#lib/managers/auth-manager.svelte.ts'`. Never `$lib`. Other aliases: `#i18n/*`, `#test-data/*`, `#tests/*`. - Build URLs with the typed `Route` object in `src/lib/route.ts`. `continue`/`previousRoute` query params must

118k12d agoReviewMountCreate a free account to mount
JuliusBrusseeAGENTS.md

caveman / engine

JuliusBrussee/caveman/engine/AGENTS.md

converter; both directions fail closed. ## Conventions - Build/test: `make product-build PRODUCT=engine` / `make product-test PRODUCT=engine`. - A new compressor is a self-contained file in `compressors/` + tests, registered

Steady7 mentions in 2 weeks

1 project uses a version of this

115k7mo agoReviewMountCreate a free account to mount
JuliusBrusseeAGENTS.md

caveman / extension

JuliusBrussee/caveman/extension/AGENTS.md

buildReminder`/`isPrefixed`/`normMode`. No chrome/DOM/network. Loaded first (exposes `self.CavemanDirective`) and required directly by the test suite. - `src/caveman.js` — content script: per-site composer adapter + capture-phase send interception. Prepends the directive

Steady7 mentions in 2 weeks

No other project uses it yet

115k7mo agoReviewMountCreate a free account to mount
JuliusBrusseeAGENTS.md

caveman / mcp

JuliusBrussee/caveman/mcp/AGENTS.md

never raw input as JSON. ## Conventions - Build/test: `make product-build PRODUCT=mcp` / `make product-test PRODUCT=mcp`. - **stdout is the protocol channel** — logs go to stderr only (a dedicated test

Steady7 mentions in 2 weeks

No other project uses it yet

115k7mo agoReviewMountCreate a free account to mount
JuliusBrusseeAGENTS.md

caveman / mem

JuliusBrussee/caveman/mem/AGENTS.md

framing matches caveman-mcp exactly. ## Conventions - Build/test: `make product-build PRODUCT=mem` / `make product-test PRODUCT=mem` for the Go core; root `make test` also runs mirrored JS/Python wrapper tests

Steady7 mentions in 2 weeks

No other project uses it yet

115k7mo agoReviewMountCreate a free account to mount
JuliusBrusseeAGENTS.md

caveman / proxy

JuliusBrussee/caveman/proxy/AGENTS.md

inferred`, verified dollars always zero. ## Conventions - Build/test: `make product-build PRODUCT=proxy` / `make product-test PRODUCT=proxy`. - Tests inject a plain `*http.Client` to reach loopback stubs; the binary uses

Steady7 mentions in 2 weeks

No other project uses it yet

115k7mo agoReviewMountCreate a free account to mount
JuliusBrusseeAGENTS.md

caveman / shrink

JuliusBrussee/caveman/shrink/AGENTS.md

sentence (must/cannot/required/bounds/format/ ISO/RFC/absolute/etc.). `default`, `const`, and internal `$ref` targets survive. Golden and adversarial conformance tests lock these construction surfaces; over-keep is safer than a retry. ## Conventions - Build/test: `make product

Steady7 mentions in 2 weeks

No other project uses it yet

115k7mo agoReviewMountCreate a free account to mount
SupabaseAGENTS.md

supabase

supabase/supabase/AGENTS.md

introspection (`SafeSqlFragment`) | | `packages/shared-data` | Static data: pricing, plans, regions, error codes | | `e2e/studio`, `e2e/docs` | Playwright E2E tests | | `supabase/` | Local Supabase project: edge functions, migrations, config.toml | ## Common Commands ```bash pnpm dev:studio

Steady6 mentions in 2 weeks

No other project uses it yet

114k34d agoReviewMountCreate a free account to mount
SupabaseAGENTS.md

supabase / apps

supabase/supabase/apps/docs/AGENTS.md

endpoint, search embeddings, federated docs, build pipeline), `ask-the-docs` has the reference notes. ## Test requirements Before running tests for `apps/docs`, ensure local Supabase is available

Steady6 mentions in 2 weeks

No other project uses it yet

114k34d agoReviewMountCreate a free account to mount
SupabaseAGENTS.md

supabase / studio

supabase/supabase/apps/studio/AGENTS.md

fields, watch/formState, reset, number inputs | `react-hook-form` | | Displaying API errors | `studio-error-handling` | | Tests (deciding, writing, reviewing) | `studio-testing`, then `studio-mock-api-tests` (component/MSW) or `studio-e2e-tests

Steady6 mentions in 2 weeks

No other project uses it yet

114k34d agoReviewMountCreate a free account to mount
addyosmaniAGENTS.md

agent-skills

addyosmani/agent-skills/AGENTS.md

user intent to skills: - Feature / new functionality → `spec-driven-development`, then `incremental-implementation`, `test-driven-development` - Planning / breakdown → `planning-and-task-breakdown` - Bug / failure / unexpected behavior → `debugging-and-error-recovery

Steady37 mentions in 2 weeks

1 project uses a version of this

112k2d agoReviewMountCreate a free account to mount
addyosmaniAGENTS.md

agent-skills

addyosmani/agent-skills/docs/agents.md

axis review before merge | | [security-auditor](../agents/security-auditor.md) | Security Engineer | Vulnerability detection, OWASP-style audit | | [test-engineer](../agents/test-engineer.md) | QA Engineer | Test strategy, coverage analysis, Prove-It pattern | | [web-performance-auditor](../agents/web-performance-auditor.md

Steady37 mentions in 2 weeks

No other project uses it yet

112k2d agoReviewMountCreate a free account to mount
stablyaiAGENTS.md

orca

stablyai/orca/AGENTS.md

Useful Commands - **Typecheck**: `pnpm tc` (or `tc:node` / `tc:cli` / `tc:web`) - **Test**: `pnpm test [path/to/file.test.ts] --maxWorkers=2`; incremental: `pnpm test:changed [path] --maxWorkers=2` ([details](.github/CONTRIBUTING.md#targeting-local-tests

112k3mo agoReviewMountCreate a free account to mount
stablyaiAGENTS.md

orca / tests

stablyai/orca/tests/AGENTS.md

Automated App Launches - Set `ORCA_BACKGROUND_LAUNCH=1` for all tests and agent-launched apps. Use [`orca-app.ts`](e2e/helpers/orca-app.ts) / [`orca-restart.ts`](e2e/helpers/orca-restart.ts); raw `electron.launch()` calls must pass the env explicitly. - Keep windows

112k3mo agoReviewMountCreate a free account to mount
papers-we-loveAGENTS.md

papers-we-love

papers-we-love/papers-we-love/AGENTS.md

This is not an application project: there is no package manager, build, or unit-test suite. ## Layout - The root `README.md` explains the collection and points contributors to the project policies

No other project uses it yet

111k7mo agoReviewMountCreate a free account to mount
fatedierAGENTS.md

frp

fatedier/frp/AGENTS.md

binary only - `make frpc` - Build client binary only - `make all` - Build everything with formatting ### Testing - `make test` - Run unit tests - `make e2e` - Run end-to-end tests - `make e2e-trace

Steady4 mentions in 2 weeks

No other project uses it yet

110k5y agoReviewMountCreate a free account to mount
paperclipaiDeletes or force-pushesAGENTS.md

paperclip

paperclipai/paperclip/AGENTS.md

canonical connection authoring runbook for provider research, supported transport/auth patterns, credential handling, branding, implementation, testing, live proof, and PR submission. ### Scoped repository rules Before editing or reviewing files, read

110k6d agoReviewMountCreate a free account to mount
axiosAGENTS.md

axios

axios/axios/AGENTS.md

bundles). - Lint source only: `npm run lint`; focused lint: `npx eslint lib/path/to/file.js`. - Unit tests: `npm run test:vitest:unit`; focused unit test: `npm run test:vitest:unit -- tests/unit/path.test.js`. - Browser tests

109k5d 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.