bxmaximum / bxmax.cli
Extended CLI commands for Bitrix Framework
Requires
- php: >=8.1
- composer/installers: ^1.0|^2.0
README
Модуль предоставляет расширенный набор консольных команд для управления Bitrix Framework, вдохновленный подходами из Laravel и Symfony.
- Packagist: bxmaximum/bxmax.cli
- Документация: https://cli.bxmax.ru/
- GitHub: bxmaximum/bxmax.cli
Основные разделы команд
- 💾 Кеш - очистка и управление кешем
- 📦 Модули - установка, удаление и управление модулями
- 👥 Пользователи - создание, управление пользователями
- 📋 Инфоблоки - работа с инфоблоками и элементами
- 🔍 Поиск - переиндексация и управление поиском
- ⚙️ Агенты - запуск и управление агентами
- 🌐 Сайты - управление сайтами
- 🔧 Отладка - диагностика и отладка
- 💽 База данных - работа с базой данных
- 💾 Резервное копирование - создание бэкапов
Быстрый старт
Установка через Composer
Предварительно настройте Composer и консоль Битрикса: https://docs.1c-bitrix.ru/pages/get-started/composer.html
Пример composer.json с установкой модуля в local/modules/:
{
"extra": {
"installer-paths": {
"local/modules/{$name}/": ["type:bitrix-module"]
}
},
"require": {
"bxmaximum/bxmax.cli": "^1.1"
}
}
Затем:
composer require bxmaximum/bxmax.cli
После установки подключите модуль в админке: «Marketplace → Установленные решения».
Установка вручную
- Скачайте архив релиза с GitHub Releases в директорию
/local/modules/bxmax.cli/ - Установите модуль через административную панель: «Marketplace → Установленные решения»
Использование
Все команды запускаются из директории bitrix:
cd /path/to/document_root/bitrix
php bitrix.php [команда] [аргументы] [опции]
Для просмотра всех доступных команд:
php bitrix.php list
Для справки по конкретной команде:
php bitrix.php help [команда]
Примеры основных команд
# Очистка кеша php bitrix.php cache:clear # Список модулей php bitrix.php module:list # Список пользователей php bitrix.php user:list # Создание резервной копии php bitrix.php backup:create # Переиндексация поиска php bitrix.php search:reindex
Требования
- Bitrix Framework 25.0+
- PHP 8.1+
- Symfony Console Component (входит в Bitrix)
- Composer +
composer/installers(для установки через Packagist)
Обратная связь и вклад в проект
Для предложений и обсуждений:
- Создайте issue в разделе Issues на GitHub
- Напишите в Telegram: @bxmax_cli
Мы приветствуем вклад в развитие проекта! Если вы хотите добавить новую команду или улучшить существующую:
- Форкните репозиторий
- Создайте ветку для вашей функции (
git checkout -b feature/amazing-command) - Внесите изменения и добавьте тесты, если возможно
- Закоммитьте изменения с использованием Conventional Commits
- Запушьте в ветку и создайте Pull Request
Ваш код должен соответствовать стандартам PSR-12 и включать необходимую документацию.
Лицензия
MIT