AGENTS.md - stałe instrukcje dla projektu
Pliki AGENTS.md zawierają instrukcje, które Codex odczytuje przed rozpoczęciem pracy. Dzięki nim możesz ustalić stałe oczekiwania wobec zadań w projekcie. Instrukcje mogą pochodzić z ustawień globalnych i plików projektu, a bardziej szczegółowe reguły mogą nadpisywać wcześniejsze. Codex buduje łańcuch instrukcji przy uruchomieniu, raz na sesję lub uruchomienie. W ustawieniach globalnych Codex sprawdza katalog ~/.codex, chyba że zmienna CODEX_HOME wskazuje inne miejsce. Na tym poziomie używa pliku AGENTS.override.md, jeśli istnieje, a w przeciwnym razie AGENTS.md.
W projekcie Codex zaczyna od jego katalogu głównego i schodzi do bieżącego katalogu. Jeśli nie znajdzie katalogu głównego projektu, sprawdza tylko katalog bieżący. W każdym katalogu sprawdza kolejno AGENTS.override.md, AGENTS.md, a następnie nazwy zapasowe skonfigurowane w project_doc_fallback_filenames. Z jednego katalogu uwzględnia najwyżej jeden plik. Pliki są łączone od katalogu głównego w dół, więc instrukcje bliższe bieżącemu katalogowi pojawiają się później i mają pierwszeństwo. Dzięki temu możesz dopasować reguły do konkretnej części repozytorium.
Aby ustawić wspólne zasady dla repozytoriów, utwórz ~/.codex/AGENTS.md i wpisz do niego powtarzalne preferencje. Przykładowe reguły obejmują uruchamianie testów po zmianach w JavaScript i preferowanie pnpm przy instalowaniu zależności. W katalogu głównym repozytorium możesz dodać AGENTS.md z podstawowymi zasadami projektu, a w podkatalogu umieścić plik z regułami dla konkretnego zespołu. Plik AGENTS.override.md w katalogu płatności może na przykład zastąpić tamtejszy AGENTS.md. Puste pliki są pomijane, a dodawanie instrukcji kończy się po osiągnięciu limitu łącznego rozmiaru, który domyślnie wynosi 32 KiB. Gdy limit staje się problemem, możesz go zwiększyć albo rozdzielić instrukcje między zagnieżdżone katalogi.
AGENTS.md.mkdir -p ~/.codex
AGENTS.md preferencje, które mają obowiązywać w każdym repozytorium.# ~/.codex/AGENTS.md ## Working agreements - Always run `npm test` after modifying JavaScript files. - Prefer `pnpm` when installing dependencies. - Ask for confirmation before adding new production dependencies.
# services/payments/AGENTS.override.md ## Payments service rules - Use `make test-payments` instead of `npm test`. - Never rotate API keys without notifying the security channel.
Zastosowanie w praktyce
Użyj globalnego AGENTS.md, gdy chcesz, by każde repozytorium dziedziczyło te same preferencje dotyczące pracy. Możesz tam zapisać wymagania związane z testami, menedżerem pakietów lub zgodą na nowe zależności produkcyjne. Dodaj AGENTS.md w katalogu głównym projektu, gdy chcesz przekazać Codexowi podstawowe zasady repozytorium. Przykładowe zastosowania to polecenie uruchomienia lintowania przed pull requestem oraz dokumentowanie publicznych narzędzi po zmianie ich zachowania. Stosuj plik AGENTS.override.md w zagnieżdżonym katalogu, gdy dany zespół potrzebuje innych zasad niż te z katalogu głównego. Przykładowo serwis płatności może używać make test-payments zamiast npm test. Jeśli repozytorium używa innej nazwy pliku z instrukcjami, dodaj ją do project_doc_fallback_filenames. Nazwy, których nie ma na tej liście, są pomijane przy wykrywaniu instrukcji.