Сайт ↗
Разделы документации
CLI интерфейс · 0.8.1

CLI: проверить модель и сгенерировать файлы

Doctor, plan, dry-run и Generate: результаты, конфликты и границы восстановления.

На этой странице

После изменения модели используйте последовательность doctor → plan → generate --dry-run → generate. Во всех вызовах --path указывает каталог нужного проекта.

Проверить каталог и модель

admingen-cli --path ./docs-demo --output json doctor
admingen-cli --path ./docs-demo --output json plan

doctor показывает initialized, путь и, если проект есть, его модель и число сущностей. Он проверяет инициализацию, а не готовность PostgreSQL или веб-сервера.

plan проверяет и нормализует модель, составляет операции над файлами и показывает предупреждения и конфликты. Сгенерированные файлы при этом не записываются.

Посмотреть различия и применить их

admingen-cli --path ./docs-demo generate --dry-run
admingen-cli --path ./docs-demo generate
Команда/флаг Что делает
plan Рассчитывает план генерации.
generate --dry-run Рендерит содержимое и показывает diff без записи generated-файлов.
generate Применяет допустимые изменения, обновляет lock/history и baseline успешной модели.
generate --force Разрешает перезапись отслеживаемых generated-файлов, изменённых вручную.

В JSON смотрите blocked, summary и files. Для файла показаны путь, действие или статус, diff и причина конфликта. sync_metadata означает, что содержимое уже совпадает, но служебные сведения нужно обновить; исходник не переписывается.

Generate не применяет SQL, не запускает приложение и не разворачивает релиз. После него по ситуации нужны миграции, сборка и перезапуск созданного проекта. Порядок — локальная разработка.

Если возник конфликт

  1. Найдите файл и причину в dry-run.
  2. Если вы добавили бизнес-логику в generated-файл, перенесите её в предусмотренную custom-зону.
  3. Повторите просмотр. Используйте --force только если готовы потерять ручную версию файла, принадлежащего генератору.
  4. Сохраните lock: удаление этого файла не является универсальным исправлением.

Force не разрешает перезаписывать custom и не превращает generated-файл в точку для ручных расширений. Подробнее — владение файлами.

Где история и восстановление модели

История хранится в .admingen/history/, модель последней успешной генерации — в .admingen/baselines/last-successful-project.yaml. Не редактируйте служебные файлы вручную. Просмотр истории и предварительный просмотр восстановления доступны в Generator UI.

Отдельных команд history, diff и rollback в CLI нет. Для diff используйте dry-run.

Восстановление модели, возврат Git-коммита, откат образов и восстановление БД из backup решают разные задачи. Возврат модели не отменяет уже применённый SQL. Порядок действий описан в генерации и восстановлении и backup и rollback.