Использование

Основы работы с консолью Битрикса

Все команды запускаются из директории bitrix вашего сайта:

cd /path/to/document_root/bitrix
php bitrix.php [команда] [аргументы] [опции]

Просмотр доступных команд

Для просмотра всех доступных команд используйте:

php bitrix.php list

Эта команда выведет список всех доступных команд с кратким описанием.

Справка по команде

Для получения подробной справки по конкретной команде используйте:

php bitrix.php help [команда]

Например:

php bitrix.php help cache:clear
php bitrix.php help iblock:list
php bitrix.php help backup:create

Структура команды

Команды состоят из следующих компонентов:

php bitrix.php [команда] [аргументы] [опции]

Аргументы

Аргументы - это обязательные или опциональные параметры команды, которые передаются без префиксов:

php bitrix.php user:password admin
php bitrix.php iblock:elements 5
php bitrix.php site:info s1

Опции

Опции - это необязательные параметры, которые начинаются с -- или -:

# Длинный формат опции
php bitrix.php user:list --limit=50 --active

# Короткий формат опции (если доступен)
php bitrix.php user:list -l 50

# Опции-флаги (без значения)
php bitrix.php backup:create --skip-kernel --skip-db

Уровни вывода (Verbosity)

Многие команды поддерживают управление уровнем детализации вывода:

# Нормальный вывод
php bitrix.php cache:clear

# Подробный вывод (-v)
php bitrix.php cache:clear -v

# Очень подробный вывод (-vv)
php bitrix.php cache:clear -vv

# Отладочный вывод (-vvv)
php bitrix.php cache:clear -vvv

# Тихий режим (без вывода, кроме ошибок) (-q)
php bitrix.php cache:clear -q

Примеры использования

Простая команда без параметров

php bitrix.php cache:clear
php bitrix.php module:list
php bitrix.php agent:run

Команда с аргументом

php bitrix.php user:password admin --password=NewPass123
php bitrix.php iblock:elements 1
php bitrix.php site:info s1

Команда с несколькими опциями

php bitrix.php user:list --limit=50 --active
php bitrix.php backup:create --name=my_backup --skip-kernel --skip-stat

Команда с множественными значениями опции

php bitrix.php backup:create \
  --exclude-dir=/bitrix/cache \
  --exclude-dir=/upload/tmp \
  --exclude-mask="*.log" \
  --exclude-mask="*.tmp"

Интерактивный режим

Некоторые команды могут запрашивать дополнительные данные в интерактивном режиме:

php bitrix.php user:create
# Команда запросит: логин, email, пароль, имя и т.д.

Вы также можете передать все параметры через опции, чтобы избежать интерактивного ввода:

php bitrix.php user:create \
  --login=john \
  --email=john@example.com \
  --password=SecurePass123 \
  --name=John \
  --last-name=Doe

Использование в скриптах и автоматизации

Запуск команд из скриптов

#!/bin/bash
cd /var/www/bitrix
php bitrix.php cache:clear
php bitrix.php agent:run

Использование в cron

# Очистка кеша каждый день в 3:00
0 3 * * * cd /var/www/bitrix && php bitrix.php cache:clear

# Запуск агентов каждые 5 минут
*/5 * * * * cd /var/www/bitrix && php bitrix.php agent:run

Больше примеров использования в cron смотрите в разделе Примеры cron.

Обработка ошибок

При возникновении ошибки команда:

• Возвращает ненулевой код завершения
• Выводит сообщение об ошибке в stderr

Это позволяет правильно обрабатывать ошибки в скриптах:

#!/bin/bash
if php bitrix.php cache:clear; then
    echo "Кеш успешно очищен"
else
    echo "Ошибка при очистке кеша"
    exit 1
fi

Перенаправление вывода

Вы можете перенаправлять вывод команд:

# Сохранить вывод в файл
php bitrix.php module:list > modules.txt

# Добавить вывод к существующему файлу
php bitrix.php user:list >> users.txt

# Перенаправить ошибки
php bitrix.php backup:create 2> errors.log

# Перенаправить всё (вывод и ошибки)
php bitrix.php backup:create &> backup.log

Автодополнение

Для удобства работы в терминале можно настроить автодополнение команд. Подробнее см. Команды утилит.