AGENTS.mdAGENTS.md: lokalizacja i sposób odczytu przez narzędzia
AGENTS.md to zwykły plik Markdown z instrukcjami dla projektu, który większość agentów programistycznych odczytuje bez dodatkowej konfiguracji. OpenAI przekazało go Agentic AI Foundation działającej przy Linux Foundation. Korzysta z niego ponad 60k projektów open source.
Lokalizacja
- AGENTS.md w katalogu głównym repozytorium — dla całego projektu.
- Zagnieżdżone pliki AGENTS.md w podkatalogach lub pakietach; agenci używają pliku znajdującego się najbliżej w hierarchii.
- OpenAI Codex: globalny plik ~/.codex/AGENTS.override.md albo, jeśli jest pusty lub nie istnieje, ~/.codex/AGENTS.md.
- Cline: globalny plik ~/.agents/AGENTS.md.
- Claude Code obsługuje również .claude/AGENTS.md.
Format
Zwykły Markdown bez front matter i wymaganych pól; nagłówki mogą mieć dowolną postać. Format nie określa limitu rozmiaru, ale OpenAI Codex przestaje czytać po osiągnięciu project_doc_max_bytes, domyślnie 32 KiB.
# Acme web app
Customer-facing web app with an admin area and a REST API.
## Commands
- Install: `pnpm install`
- Test: `pnpm test`
- Lint and type-check: `pnpm lint && pnpm tsc --noEmit`
## Code style
- TypeScript strict mode; no `any` in new code.
- Keep database access in `src/db/`.
## Never
- Never commit secrets or .env files.
- Never edit files under `src/generated/` by hand.
Priorytety i scalanie
Obowiązuje plik AGENTS.md położony najbliżej edytowanego pliku, a jawna instrukcja na czacie ma pierwszeństwo przed każdym plikiem. OpenAI Codex łączy pliki po jednym z każdego katalogu, od katalogu głównego projektu do katalogu roboczego; bliższe pliki trafiają na końcu i mają wyższy priorytet. Claude Code domyślnie pomija AGENTS.md, jeśli istnieje plik CLAUDE.md.
Narzędzia, które go odczytują
| Narzędzie | Obsługa |
|---|---|
| OpenAI Codex | Obsługiwane natywnie. Odczytuje plik globalny, a następnie maksymalnie jeden plik z każdego katalogu — od katalogu głównego do katalogu roboczego; domyślny limit to 32 KiB. |
| Claude Code | Obsługiwane natywnie od wersji v2.1.277, ale tylko wtedy, gdy nie istnieje CLAUDE.md ani CLAUDE.local.md, chyba że ustawiono claude-md-and-agents-md. |
| Cursor | Obsługiwane natywnie w katalogu głównym i podkatalogach; zagnieżdżone pliki łączą się z nadrzędnymi, a bardziej szczegółowy plik ma pierwszeństwo. |
| GitHub Copilot (cloud agent, code review, VS Code) | Obsługiwane natywnie w dowolnym miejscu repozytorium; obowiązuje najbliższy plik. |
| Devin Desktop (formerly Windsurf) | Obsługiwane natywnie. Plik w katalogu głównym jest zawsze aktywny; plik w podkatalogu dotyczy tego katalogu. |
| Cline | Obsługiwane natywnie, także z globalnym plikiem ~/.agents/AGENTS.md; włącz lub wyłącz obsługę w panelu Rules. |
| Gemini CLI | Opcjonalnie: dodaj AGENTS.md do context.fileName w .gemini/settings.json. |
| Aider | Opcjonalnie: dodaj read: AGENTS.md do .aider.conf.yml. |
| OpenClaw | Obsługiwane natywnie jako wymagany plik z instrukcjami operacyjnymi w obszarze roboczym agenta. |
| Listed on agents.md (not individually re-verified) | Jedno z 23 narzędzi na liście agents.md, obejmującej m.in. Amp, Jules, Zed, Warp, goose, opencode i JetBrains Junie; nie weryfikowaliśmy ich osobno. |
Wskazówki
- Zmieniasz nazwę starszego pliku AGENT.md? agents.md sugeruje użycie mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md, aby obie nazwy nadal działały.
- Wymień polecenia do testów i lintowania: agenci próbują uruchamiać znalezione kontrole i naprawiają błędy przed zakończeniem pracy.
- W monorepo dodaj krótki plik AGENTS.md do każdego pakietu, zamiast rozbudowywać jeden długi plik w katalogu głównym.
- W OpenAI Codex plik AGENTS.override.md ma pierwszeństwo przed AGENTS.md w tym samym katalogu.
Wygeneruj plik AGENTS.md i pasujące pliki reguł dla pięciu narzędzi za pomocą jednego formularza. Otwórz generator AGENTS.md →