Справочник CLI¶
Все команды запускаются через CLI плагинов Grav из корня сайта:
Краткий справочник¶
| Команда | Что делает | Безопасна на действующем сайте? |
|---|---|---|
status |
Сообщает о базе данных, схеме, очереди заданий, фоновом процессе и обновлениях в реальном времени | Да, только чтение |
migrate |
Применяет ожидающие миграции базы данных | Да |
work |
Выполняет один проход фонового процесса | Да |
jobs |
Перечисляет задания, запускает или отменяет одно | Да |
reindex |
Перестраивает поисковый индекс | Да; пока он идёт, поиск переходит на обычное совпадение |
blocklist |
Перечисляет, добавляет и удаляет записи чёрного списка гостевой формы | Да |
erase |
Удаляет человека сейчас | Да, но это нельзя отменить |
inbound:feed |
Проводит одно исходное письмо через обработку входящей почты | Да |
imap:poll |
Читает почтовый ящик IMAP сейчас | Да |
status¶
Печатает путь к базе данных и её размер, применённые и ожидающие шаги миграций, очередь заданий по состояниям, последний запуск фонового процесса и признак устаревания очереди, зарегистрированные типы заданий и строку crontab для Grav. --json печатает тот же отчёт, что GET /helpdesk-pro/status. Это первая команда, которую нужно запускать, когда что-то не происходит. См. Устранение неполадок.
migrate¶
bin/plugin helpdesk-pro migrate --status # список ожидающих миграций
bin/plugin helpdesk-pro migrate # применить
Применяет ожидающие миграции плагина и каждого дополнения, зарегистрировавшего свои. Запускайте её после каждого обновления, когда database.auto_migrate равно manual.
work¶
Один проход фонового процесса: выполняет готовые задания, планирует периодические, записывает запуск процесса и запускает тик процесса. Планировщик запускает её каждую минуту. --max-time — бюджет времени в секундах (по умолчанию 50), а --max-jobs — максимум заданий (по умолчанию 50, 0 без ограничения). Процесс отказывается работать, пока есть ожидающие миграции.
jobs¶
bin/plugin helpdesk-pro jobs
bin/plugin helpdesk-pro jobs --state=failed --type=mail.send --limit=50
bin/plugin helpdesk-pro jobs --run=123
bin/plugin helpdesk-pro jobs --cancel=123
Перечисляет новые задания с их состоянием, попытками и последней ошибкой.
| Параметр | Что делает |
|---|---|
--state |
pending, running, failed, complete или cancelled |
--type |
Только задания этого типа, например mail.send |
--limit |
Сколько перечислить (по умолчанию 25) |
--run=<id> |
Запускает одно задание сейчас через тот же код фонового процесса, давая неудачному заданию ещё одну попытку |
--cancel=<id> |
Отменяет задание. Выполняющееся останавливается на следующей контрольной точке. |
reindex¶
bin/plugin helpdesk-pro reindex
bin/plugin helpdesk-pro reindex --scope=kb
bin/plugin helpdesk-pro reindex --status
Перестраивает поисковый индекс на месте и печатает, сколько документов записано. --scope=tickets или --scope=kb перестраивает одну часть (по умолчанию all). --status печатает состояние индекса (файл, размер, число документов, последнюю перестройку, семантический поиск), не перестраивая его. См. Поиск.
blocklist¶
bin/plugin helpdesk-pro blocklist # список всех записей
bin/plugin helpdesk-pro blocklist list ip # список одного типа
bin/plugin helpdesk-pro blocklist add email spammer@example.com --note="repeat offender"
bin/plugin helpdesk-pro blocklist remove email spammer@example.com
Управляет чёрным списком гостевой формы. Типы — email, domain (example.com также блокирует поддомены), ip (адрес или диапазон CIDR, например 203.0.113.0/24) и word. --note записывает причину (только при добавлении). Значения хранятся в нижнем регистре. См. Форму запроса и гостей.
erase¶
Удаляет человека сейчас: та же работа, которую Erase в рабочей области ставит в очередь как задание people.erase. Режим по умолчанию анонимизирует его; --mode=delete_content также заменяет всё написанное им на «[removed]» и удаляет его файлы. Команда спрашивает перед началом, если не передан --yes (-y), отказывает человеку под юридическим удержанием и печатает, сколько заявок обновлено и сколько файлов отпущено. Безопасно запускать дважды. См. Люди и конфиденциальность.
inbound:feed¶
bin/plugin helpdesk-pro inbound:feed reply.eml
cat reply.eml | bin/plugin helpdesk-pro inbound:feed --to=support+t8f2k@example.com
bin/plugin helpdesk-pro inbound:feed --no-process --to support@example.com
Проводит одно исходное письмо через обработку входящей почты из файла или стандартного ввода (не указывайте файл или передайте -).
| Параметр | Что делает |
|---|---|
--to |
Получатель конверта, список через запятую. Здесь сохраняется адрес с +token, когда заголовок To: содержит только support@. |
--from |
Отправитель конверта (--from="" для bounce). |
--no-process |
Только сохранить письмо; обработает его фоновый процесс. Без параметра письмо обрабатывается сразу, и результат печатается (Inbound email #12: created, ticket #40). |
Уже полученное письмо печатает свой номер и ничего не делает. Команда завершается с 75, когда письмо не удалось сохранить или плагин Email не поддерживает входящую почту, чтобы почтовый сервер сохранил письмо и повторил попытку, и с 1 для пустого или слишком большого письма. См. Входящую почту.
imap:poll¶
Читает почтовый ящик IMAP сейчас, что бы ни говорила задержка, и печатает, сколько писем сохранено, уже получено и слишком велико. --work также запускает фоновый процесс после, поэтому новые письма обрабатываются сразу. Команда завершается с 1, когда ящик не настроен, не читается или плагин Email старше 5.3.0. С приёмником, отличным от imap, она всё равно опрашивает один раз и сообщает, что периодический опрос не запущен. См. Входящую почту.