Generator AGENTS.md
Wypełnij jeden formularz, aby wygenerować AGENTS.md z poleceniami, konwencjami i bezwzględnymi ograniczeniami. Otrzymasz też jedną regułę przypisaną do ścieżek, przygotowaną dla Cursor, GitHub Copilot, Claude Code, Cline i Devin Desktop, a także pliki pomostowe dla narzędzi, które domyślnie nie odczytują AGENTS.md.
Gdzie poszczególne narzędzia szukają plików z instrukcjami →
# Aplikacja webowa Acme
Aplikacja webowa dla klientów z panelem administracyjnym i niewielkim REST API.
## Uwzględnij stack
Next.js, React, TypeScript, pnpm
## Podaj polecenia
- Instaluj: `pnpm install`
- Uruchamiaj lokalnie: `pnpm dev`
- Testuj: `pnpm test`
- Uruchamiaj lint i sprawdzanie typów: `pnpm lint && pnpm tsc --noEmit`
- Buduj: `pnpm build`
## Przestrzegaj stylu kodu
- Przestrzegaj formatowania wymuszanego przez linter i pozostawiaj nietknięte pliki bez zmian.
- Preferuj małe funkcje z jasno określonymi danymi wejściowymi i wynikami; ograniczaj efekty uboczne do warstw zewnętrznych.
- Zapytaj przed dodaniem nowej zależności.
- Wyjaśniaj komentarzami powody nieoczywistych rozwiązań, a nie działanie poszczególnych linii.
## Testowanie
- Dodaj lub zaktualizuj test dla każdego zmienianego zachowania.
- Uruchom polecenie testów i napraw błędy, zanim zgłosisz zakończenie pracy.
- Nie usuwaj ani nie pomijaj nieudanego testu, żeby uzyskać zielony wynik całego zestawu.
## Commity i pull requesty
- Pisz tytuły commitów w trybie rozkazującym i nie przekraczaj 72 znaków.
- Ograniczaj każdy pull request do jednej zmiany i opisz, jak ją przetestowano.
- Uruchamiaj lint i testy przed każdym commitem.
## Nigdy
- Nigdy nie commituj sekretów, kluczy API ani plików .env.
- Nigdy nie edytuj ręcznie wygenerowanych plików w src/generated/; wygeneruj je ponownie.
- Nigdy nie uruchamiaj destrukcyjnych poleceń dotyczących bazy danych na środowisku produkcyjnym.
- Nigdy nie wykonuj force-push na main ani nie zmieniaj wspólnej historii.
Ta sama reguła dla pięciu narzędzi
---
description: Konwencje dla plików pasujących do tego globu
globs: app/**/*.tsx
alwaysApply: false
---
Stosuj wzorce używane już w sąsiednich plikach w tym folderze. Każda eksportowana funkcja musi mieć docstring i test w odpowiadającym jej pliku testowym.
---
applyTo: "app/**/*.tsx"
---
Stosuj wzorce używane już w sąsiednich plikach w tym folderze. Każda eksportowana funkcja musi mieć docstring i test w odpowiadającym jej pliku testowym.
---
paths:
- "app/**/*.tsx"
---
Stosuj wzorce używane już w sąsiednich plikach w tym folderze. Każda eksportowana funkcja musi mieć docstring i test w odpowiadającym jej pliku testowym.
---
paths:
- "app/**/*.tsx"
---
Stosuj wzorce używane już w sąsiednich plikach w tym folderze. Każda eksportowana funkcja musi mieć docstring i test w odpowiadającym jej pliku testowym.
---
trigger: glob
globs: app/**/*.tsx
---
Stosuj wzorce używane już w sąsiednich plikach w tym folderze. Każda eksportowana funkcja musi mieć docstring i test w odpowiadającym jej pliku testowym.
Co sprawia, że plik z instrukcjami działa
Umieść dokładne polecenia na początku
Na początku pliku podaj rzeczywiste polecenia instalacji, testów i lintowania wraz z flagami. Precyzyjnie określ stack i wersje, a tam, gdzie opis słowny byłby niejasny, dodaj krótki przykład kodu.
Wyraźnie określ, czego nie wolno robić
Napisz wprost, czego agentowi nie wolno robić, na przykład modyfikować sekretów, vendored code ani środowiska produkcyjnego. Najczęściej przydatnym ograniczeniem w plikach przeanalizowanych przez GitHub było: nigdy nie commituj sekretów.
Formułuj instrukcje tak, by można je było zweryfikować
Uruchom npm test przed commitem można zweryfikować; przetestuj swoje zmiany — nie. Usuń sprzeczności, bo gdy dwie linie sobie przeczą, model może zastosować dowolną z nich.
Pisz zwięźle i dziel zasady według ścieżek
Anthropic zaleca mniej niż 200 linii w pliku, a Cursor — mniej niż 500 w każdej regule. Przenieś wskazówki dotyczące danego obszaru do reguły przypisanej do ścieżki, aby była wczytywana tylko wtedy, gdy dotyczą jej edytowane pliki. Importy porządkują plik, ale nie zmniejszają kosztu kontekstu.
Pomiń informacje, które agent już zna
W badaniu obejmującym czterech agentów do kodowania pliki kontekstowe nie zwiększały w przewidywalny sposób skuteczności zadań, a podnosiły koszt inferencji o ponad 20%. Pliki napisane przez LLM nieznacznie pogarszały wyniki, a opisy repozytoriów nie pomagały. Ogranicz więc plik do nieoczywistych wymagań, takich jak konkretne narzędzia.
Dodawaj zasady, gdy błędy się powtarzają
Zacznij od krótkiego pliku i dodaj regułę, gdy agent popełni ten sam błąd więcej niż raz. Zamiast wklejać cały przewodnik po stylu, wskaż istniejący plik jako wzorzec.
Pytania o AGENTS.md
Czy Claude Code odczytuje AGENTS.md?
Tak, od wersji v2.1.277. Domyślnie odczytuje AGENTS.md lub .claude/AGENTS.md tylko wtedy, gdy w katalogu roboczym ani wyżej nie ma pliku CLAUDE.md, .claude/CLAUDE.md lub CLAUDE.local.md. Ustawienie claude-md-and-agents-md wczytuje oba pliki, a plik CLAUDE.md zawierający @AGENTS.md działa w każdej wersji.
Czy AGENTS.md wymaga frontmatter lub określonych nagłówków?
Nie. AGENTS.md to zwykły plik Markdown bez wymaganych pól; możesz użyć dowolnych nagłówków. Serwis agents.md sugeruje sekcje takie jak opis projektu, polecenia kompilacji i testów, styl kodu, testowanie, informacje o bezpieczeństwie oraz wytyczne dotyczące pull requestów.
Jak używać AGENTS.md w monorepo?
Umieść jeden plik AGENTS.md w katalogu głównym, a kolejne w pakietach wymagających własnych zasad. Agenci odczytują plik znajdujący się najbliżej edytowanego kodu; w razie konfliktu obowiązuje ten plik. Gdy serwis agents.md opisywał to rozwiązanie, główne repozytorium OpenAI zawierało 88 takich plików.
Jak skonfigurować Gemini CLI, aby odczytywał AGENTS.md?
Gemini CLI nadal domyślnie korzysta z GEMINI.md. Dodaj AGENTS.md do context.fileName w .gemini/settings.json, na przykład ["AGENTS.md", "GEMINI.md"]. Uruchom /memory show, aby sprawdzić, co zostało wczytane.
Które agenty do kodowania obsługują AGENTS.md?
Sprawdziliśmy dokumentację OpenAI Codex, Claude Code, Cursor, GitHub Copilot, Devin Desktop, Cline i OpenClaw — wszystkie natywnie odczytują ten plik. Gemini CLI i Aider wymagają jednej linijki konfiguracji. Witryna agents.md wymienia łącznie 23 zgodne narzędzia, w tym Zed, Warp, goose, opencode, Jules i JetBrains Junie.
Kto odpowiada za format AGENTS.md?
OpenAI przekazało AGENTS.md do Agentic AI Foundation, funduszu zarządzanego przez Linux Foundation, ogłoszonego 2025-12-09 wraz z MCP i goose. Witryna agents.md podaje, że korzysta z niego ponad 60 tys. projektów open source.