Команды управления модулями
Команды для управления модулями Bitrix: просмотр списка, установка, удаление и загрузка с GitHub.
module:list
Выводит список всех установленных модулей с версиями и статусом установки.
Синтаксис
bash
php bitrix.php module:listПримеры использования
bash
# Просмотр всех установленных модулей
php bitrix.php module:listВывод команды
Команда выводит таблицу со следующей информацией:
- ID модуля - идентификатор модуля
- Название - название модуля
- Версия - текущая версия
- Статус - установлен или нет
module:install
Устанавливает модуль по его идентификатору.
Синтаксис
bash
php bitrix.php module:install <module>Аргументы
module- идентификатор модуля для установки
Примеры использования
bash
# Установка кастомного модуля
php bitrix.php module:install custom.module
# Установка стандартного модуля Битрикс
php bitrix.php module:install iblock
php bitrix.php module:install catalog
php bitrix.php module:install saleОсобенности
- Команда проверяет, установлен ли уже модуль
- При установке выполняются все необходимые миграции базы данных
- Копируются необходимые файлы модуля
- Регистрируются события и обработчики
module:uninstall
Удаляет установленный модуль.
Синтаксис
bash
php bitrix.php module:uninstall <module>Аргументы
module- идентификатор модуля для удаления
Примеры использования
bash
# Удаление кастомного модуля
php bitrix.php module:uninstall custom.module
# Удаление стандартного модуля
php bitrix.php module:uninstall iblockПредупреждения
⚠️ Внимание! Удаление модуля может привести к:
- Потере данных модуля
- Удалению таблиц базы данных
- Удалению файлов модуля
- Нарушению работы зависимых модулей
Убедитесь, что понимаете последствия перед удалением модуля.
module:github
Загружает и устанавливает модуль напрямую из GitHub репозитория.
Синтаксис
bash
php bitrix.php module:github <repository>Аргументы
repository- URL GitHub репозитория или короткое имя (username/repo)
Примеры использования
bash
# Загрузка по полному URL
php bitrix.php module:github https://github.com/andreyryabin/sprint.migration
# Другие примеры популярных модулей
php bitrix.php module:github https://github.com/mesilov/bitrix-reduce-migrations
php bitrix.php module:github https://github.com/bitrix-expert/toolsКак это работает
- Команда клонирует репозиторий из GitHub
- Определяет идентификатор модуля
- Копирует файлы модуля в
/local/modules/ - Предлагает установить модуль
Требования
- Доступ к GitHub (без ограничений firewall)
- Права на запись в директорию
/local/modules/
Особенности
- Загружается последняя версия из ветки
master(илиmain) - Временные файлы загрузки автоматически удаляются
- Поддерживаются публичные репозитории
Использование в автоматизации
Скрипт установки модулей
bash
#!/bin/bash
# Установка необходимых модулей для проекта
MODULES=(
"iblock"
"catalog"
"sale"
"custom.module"
)
for module in "${MODULES[@]}"; do
echo "Установка модуля: $module"
php bitrix.php module:install "$module"
doneПроверка установленных модулей
bash
#!/bin/bash
# Проверка наличия необходимых модулей
REQUIRED_MODULES=("iblock" "catalog" "sale")
for module in "${REQUIRED_MODULES[@]}"; do
if php bitrix.php module:list | grep -q "$module"; then
echo "✓ Модуль $module установлен"
else
echo "✗ Модуль $module не установлен"
php bitrix.php module:install "$module"
fi
doneTroubleshooting
Модуль не устанавливается
Проблема: Ошибка при установке модуля
Решения:
- Проверьте права доступа к директории
/bitrix/modules/или/local/modules/ - Убедитесь, что модуль совместим с вашей версией Битрикс
- Проверьте логи PHP и Битрикс
- Убедитесь, что все зависимости модуля установлены
Ошибка при загрузке с GitHub
Проблема: Не удается загрузить модуль из GitHub
Решения:
- Проверьте доступ к GitHub:
ping github.com - Убедитесь, что URL репозитория правильный
- Проверьте, что репозиторий публичный
Модуль установлен, но не работает
Проблема: Модуль показывается как установленный, но его функционал не работает
Решения:
- Очистите кеш:
php bitrix.php cache:clear - Переустановите модуль:bash
php bitrix.php module:uninstall module.id php bitrix.php module:install module.id - Проверьте логи ошибок
- Убедитесь, что все файлы модуля скопированы
Смотрите также
- Команды кеша - очистка кеша после установки модулей
- Команды обновлений - обновление модулей
- Официальная документация Битрикс по модулям