shevartv / modx-builder
Package builder CLI for MODX Revolution 3
0.4.8
2026-10-02 17:48 UTC
Requires (Dev)
None
Suggests
- ext-openssl: Required by `modxapp setup` to download MODX core from GitHub
- ext-pdo_sqlite: Required by `modxapp setup` and headless (SQLite) builds
Provides
None
Conflicts
None
Replaces
None
README
CLI-инструмент для быстрого старта разработки пакетов под MODX Revolution 3.
Возможности
- Создание структуры пакета за одну команду
- Сборка transport.zip без установленного MODX (headless-режим с SQLite)
- Добавление элементов (сниппеты, чанки, плагины, TV, меню) без входа в админку
- Извлечение лексиконов и настроек из PHP-кода
- PHPStan, PHP CS Fixer, ESLint — настраиваются автоматически
- PHPUnit тесты из коробки — моки MODX без реальной БД
- Кастомные шаблоны для разных типов пакетов
- Шифрование платных пакетов через modstore.pro
Установка
composer global require shevartv/modx-builder
Быстрый старт
modxapp setup # скачать ядро MODX (если нет) modxapp config # настроить данные автора modxapp create mypackage # создать пакет modxapp build mypackage # собрать transport.zip
Документация
shevartv.github.io/modx-builder
Режимы работы
- Standalone — MODX не нужен.
modxapp setupодин раз скачивает ядро в~/.modxapp(Windows:%USERPROFILE%\.modxapp) и собирает пакеты через SQLite. - Full — команда запускается в корне установленного MODX 3: доступны
elements,export,schema-extractиbuild --install.
Требования
- PHP 8.1+ с расширениями
zip,pdo_sqlite,openssl,mbstring - Composer
- Linux, macOS или Windows (PowerShell/cmd, без WSL) — настройка PHP на Windows