Правила Kodik
Правила Kodik — это постоянные инструкции, которые включаются в системный промпт агента при каждом разговоре. Используйте их, чтобы задать стиль кода, требования к документации, соглашения о паттернах или любые другие предпочтения для конкретного проекта или глобально.
Где хранятся правила
Заголовок раздела «Где хранятся правила»Правила рабочего пространства
Заголовок раздела «Правила рабочего пространства»Файл или папка .kodik/rules в корне вашего проекта.
- Файл:
.kodik/rules— один markdown-файл с инструкциями. - Папка:
.kodik/rules/— директория, содержащая любое количество.mdфайлов. Kodik автоматически рекурсивно читает все файлы и объединяет их в единый набор правил. Файлы сортируются по имени, поэтому числовые префиксы (01-coding.md,02-docs.md) позволяют управлять порядком.
Пример структуры папки:
your-project/.kodik/├── rules/│ ├── 01-coding.md│ ├── 02-documentation.md│ └── current-sprint.mdГлобальные правила
Заголовок раздела «Глобальные правила»Расположение глобальной директории правил зависит от ОС:
| ОС | Расположение по умолчанию | Примечание |
|---|---|---|
| Windows | Documents\Kodik\Rules | Системная папка Документы |
| macOS | ~/Documents/Kodik/Rules | Пользовательская папка Документы |
| Linux / WSL | ~/Documents/Kodik/Rules | Может быть ~/Kodik/Rules на некоторых системах |
Глобальная директория всегда является папкой (не файлом). Kodik рекурсивно читает все .md файлы внутри неё.
Для пользователей Linux/WSL: если глобальные правила не находятся в
~/Documents/Kodik/Rules, проверьте~/Kodik/Rules.
Правила плагинов
Заголовок раздела «Правила плагинов»Установленные и включённые плагины могут предоставлять собственные правила. Они добавляются в системный промпт автоматически под заголовком # Plugin Rules — редактировать их не нужно. Отключение плагина убирает его правила.
Включение и отключение правил
Заголовок раздела «Включение и отключение правил»Каждый файл правил можно включить или отключить отдельно через всплывающую панель под полем ввода чата. Панель показывает:
- Глобальные правила (из пользовательских настроек)
- Правила рабочего пространства (из
.kodik/rules/текущего проекта)
Одним кликом можно включать только нужные правила — например, react-rules.md при работе с React-компонентами или memory-bank.md при работе с банком памяти. Изменения применяются к следующему запросу.
Создание правила
Заголовок раздела «Создание правила»Нажмите кнопку + на вкладке Правил. Kodik откроет новый файл в редакторе — сохраните его, и он автоматически появится в списке активных правил.
Советы по написанию эффективных правил
Заголовок раздела «Советы по написанию эффективных правил»- Конкретика важнее общих слов. Вместо «пиши хороший код» — «все публичные функции должны иметь JSDoc-комментарии».
- Держите файлы сфокусированными. Один файл — одна область (например, стиль кода, тестирование, документация).
- Избегайте избыточности. Правила занимают место в системном промпте; длинные или дублирующие правила снижают качество ответов.
- Итерируйте. Проверяйте, как правила влияют на ответы агента, и уточняйте формулировки.
Пример структуры правила
Заголовок раздела «Пример структуры правила»# Руководство по проекту
## Стиль кода
- Предпочитать функциональные компоненты классам (React)- Все функции должны иметь JSDoc-комментарии- Использовать `const` везде, где возможно
## Тестирование
- Юнит-тесты обязательны для бизнес-логики- Интеграционные тесты для API-эндпоинтов
## Документация
- Обновлять `/docs` при изменении публичного API- Вести записи в CHANGELOG.mdСвязь с AGENTS.md
Заголовок раздела «Связь с AGENTS.md»Файл AGENTS.md — это отдельный механизм, дополняющий правила. Он описывает высокоуровневую архитектуру, соглашения и запуск команд для агентов. Правила .kodik/rules лучше подходят для детальных инструкций по стилю; AGENTS.md — для архитектурного контекста.