AGENTS.md
AGENTS.md — это файл в корне проекта, где можно описать конвенции, ограничения и любые другие инструкции, которые агент должен учитывать при работе в данном репозитории. Kodik находит эти файлы автоматически и добавляет их содержимое в системный промпт перед началом каждой задачи.
Связанная функция: Правила (Rules) позволяют задавать инструкции через интерфейс IDE, не создавая файлы вручную.
Порядок загрузки файлов
Заголовок раздела «Порядок загрузки файлов»Kodik обходит дерево директорий от корня проекта до текущей рабочей директории и в каждой директории ищет следующие файлы в порядке приоритета:
AGENTS.override.md— загружается первым, если существуетAGENTS.md— загружается, еслиAGENTS.override.mdотсутствует- Файлы из настройки
kodik.project_doc_fallback_filenames— проверяются следующими
Как только один из файлов найден в директории, остальные для той же директории не проверяются.
Глобальные инструкции
Заголовок раздела «Глобальные инструкции»Файл ~/Documents/Kodik/agents.md (или ~/Documents/Kodik/AGENTS.md) применяется ко всем проектам. Его содержимое добавляется в промпт перед инструкциями проекта.
Поиск корня проекта
Заголовок раздела «Поиск корня проекта»Чтобы определить границы проекта, Kodik ищет «маркер» корня — по умолчанию директорию .git. Обход дерева директорий начинается от найденного корня. Если маркер не найден, используется только текущая рабочая директория.
Настройки
Заголовок раздела «Настройки»| Настройка | По умолчанию | Описание |
|---|---|---|
kodik.project_doc_max_bytes | 32768 | Максимальный суммарный размер инструкций в байтах. Установите 0, чтобы полностью отключить загрузку AGENTS.md. |
kodik.project_doc_fallback_filenames | [] | Дополнительные имена файлов, которые проверяются, если AGENTS.md и AGENTS.override.md не найдены. |
kodik.project_root_markers | [".git"] | Имена файлов/директорий, по которым определяется корень проекта. Укажите пустой список, чтобы проверять только текущую директорию. |
Рекомендации по содержанию
Заголовок раздела «Рекомендации по содержанию»AGENTS.md хорошо подходит для:
- Команд сборки, тестирования и запуска проекта
- Соглашений по стилю кода и организации файлов
- Ограничений: что агент не должен изменять или удалять
- Описания архитектуры и ключевых зависимостей
Безопасность
Заголовок раздела «Безопасность»Файл усекается, если его размер превышает лимит kodik.project_doc_max_bytes. Файлы с недопустимой кодировкой UTF-8 вызывают предупреждение, но не блокируют запуск задачи.