ДокументацияИнструменты и помощь
Кодирующие агенты
Проект, созданный с помощью nx new, содержит правила, необходимые агенту кодирования для написания кода Nexy по-своему: порядок работы, правила кода и написания, а также один навык на каждую тему. На этой странице рассказывается, что вы получаете, куда это идет и как поддерживать его в актуальном состоянии. Работа над самим Nexy - это другая задача: прочитать корень репозитория AGENTS.md.
Что nx new добавляет
| Файл | Прочитан | Содержит |
|---|---|---|
AGENTS.md |
Codex, OpenCode | стек проекта, порядок работы, правила, список навыков |
CLAUDE.md |
Claude Code | одна строка, @AGENTS.md, поэтому оба читают один и тот же текст |
.agents/skills/ |
Codex, OpenCode | навыки |
.claude/skills/ |
Claude Code, OpenCode | те же навыки |
AGENTS.md короткое и индивидуальное. Проект Vue, маршрутизируемый клиентом, читается как «маршрутизированный клиентом, Vue, стилизованный под Tailwind»; проекту API сообщается, что представлений нет. Копируются только те навыки, которые подходят: проект React получает навык nexy-react и не получает навык Vue, серверный проект получает навыки .nexy и Markdown, проект API не получает навыка в отношении представлений.
Чтобы пропустить все это, создайте проект с помощью nx new --no-agents.
Навыки
| Навык | Обложки |
|---|---|
nexy-principles |
порядок работы, правила кода, правила написания |
nexy-ux-audit |
аудит опыта и информационной архитектуры должен выполняться перед любым представлением |
nexy-project |
режимы, папки, соглашения о файлах, конфигурация, команды |
nexy-file |
.nexy страницы, реквизит, крючки, островки |
nexy-markdown |
.md и .mdx контент |
nexy-react, nexy-preact, nexy-solid, nexy-vue, nexy-svelte |
идиоматический код для клиентской среды |
nexy-styling |
Tailwind, UnoCSS или простой CSS и маркеры дизайна |
nexy-backend |
Обработчики API, действия, WebSocket, ISR, промежуточное программное обеспечение |
nexy-modular |
контроллеры, модули, вставки и защиты модульного маршрутизатора |
nexy-security |
зависимости, ввод, сессии, авторизация, секреты |
nexy-testing |
цикл «сначала тест» и вентили |
nexy-framework-dev |
изменение самого Nexy, а не проекта, созданного с помощью Nexy |
Правила, которые они соблюдают: проверяйте опыт перед созданием представления, сначала напишите неудачный тест, одна функция выполняет одну обработку, один класс несет одно намерение, одна папка содержит один набор связанных намерений, никаких смайлов, настоящих значков SVG, простого текста, написанного для людей, и никаких рукописных DOM-скриптов в React, Vue, Svelte, Solid или Preact.
Добавьте их в существующий проект
nx skills
Запустите его в корне проекта. Он читает nexyconfig.py и package.json для поиска стека, копирует соответствующие навыки и записывает AGENTS.md и CLAUDE.md когда они отсутствуют.
Он никогда не перезаписывает написанный вами файл: существующий AGENTS.md или CLAUDE.md сохраняется, и команда сообщает вам об этом. Добавьте список навыков в свой файл вручную, если хотите. Ваш собственный навык в .claude/skills/ или .agents/skills/ остается в покое; обновляются только навыки nexy-*.
Запустите nx skills еще раз после обновления Nexy, чтобы обновить копии, и зафиксируйте результат, чтобы вся команда поделилась им.
Как агент их находит
AGENTS.md(илиCLAUDE.md, который импортирует его) считывается в начале каждого сеанса. Он называет навыки.- Каждый навык начинается с имени и описания, в котором указано, что он охватывает и когда его загружать. Агент сначала читает их и открывает навык только тогда, когда задача соответствует.
Навыки соответствуют открытому формату «Навыки агента», поэтому другие агенты, читающие папки SKILL.md, также могут их использовать.
Чего они не делают
Навыки говорят агенту, как работать; они не делают вывод правильным. Сохраняйте свои чеки:
- Прочтите, что изменил агент.
- Запустите
nx check,nx testиnx build. Навыки требуют этого и того, чтобы результаты сообщались, а не суммировались. - Аудит зависимостей, добавляемых агентом (
nexy-securityобъясняет, как это сделать).
Примеры в навыках проверены собственными тестами Nexy: импорт есть, поля конфигурации есть, команды есть, парсит Python. Это улавливает дрейф, а не ошибочные суждения.
Карта
Агент отвечает быстрее, если знает, на какой странице находится ответ.
| Вам нужно | Прочесть |
|---|---|
| продукт на одной странице | README |
| запустить проект | начало работы |
| URL файла | маршрутизация |
| динамические сегменты, макеты, страницы ошибок | страницы |
| текущий путь, запрос, файлы cookie, сеанс | крючки |
| для редактирования страницы | .nexy-файлов или просмотров |
| Markdown или MDX | уценка |
| встроенные помощники HTML | компоненты |
| режим рендеринга | SSR, CSR, ISR |
| a WebSocket | веб-сокет |
| контроллеры и модули | модульные |
| чтобы добавить конечную точку | API |
| форма, опубликованная со страницы | действия |
| почему не удалось выполнить запрос и какая страница на него отвечает | исключения |
| переводы | i18n |
| поле конфигурации | конфигурация |
| протестировать приложение | тестирование |
| клиентская сборка | интерфейс |
Инварианты проекта
__nexy__/генерируется. Никогда не редактируйте его, никогда не фиксируйте его. Удалите его, чтобы выполнить чистую сборку.- Один файл на каждый URL.
index.nexyиindex.pyдля одного и того же пути - это ошибка, а не правило приоритета. - Зарезервированные имена внутри
src/routes/:layout.nexy,loading.nexy,errors.nexy,notfound.nexy,dependencies.py,__init__.py. Не используйте их для контента. .nexyfrontmatter - это Python который выполняется для каждого запроса. Никаких побочных эффектов на уровне модуля: никаких дескрипторов файлов, никаких подключений к базе данных, никаких сетевых вызовов при импорте..pyвsrc/routes/- это обработчик API. Методы - это имена функций (GET,POST, ...).- Конфигурация находится в
nexyconfig.py, а не в переменных среды и не в разбросанных константах. - Автоэкранирование отключено в шаблонах
.nexy: экранируйте ненадежные значения с помощью| e.
nx dev # developmentnx build # production buildnx start # production servernx test # pytest, --client adds vitest
Если документация и код не совпадают, доверьтесь коду и скажите так: nexy/core/config.py содержит все параметры, nexy/modules/routers/fbrouter/ правила маршрутизации, nexy/modules/compiler/ то, как .nexy файлы становятся модулями.
Следующие шаги
- CLI:
nx newиnx skills - Соглашения о файлах: зарезервированные имена и правила маршрутизации.
- Глоссарий: слова, на которых основаны эти правила.
- Безопасность: в этой версии уровень навыков безопасности равен