Omut CLINew
Команда omut-cli: статус служб, сайты, журналы по курсору, диагностика и манифест окружения site.yaml.
Ваши проекты
Начиная с версии 1.1 вместе с приложением ставится командная строка omut-cli. Это не отдельная программа, а то же ядро Omut: список сайтов, статус служб, журналы и диагностика доступны из терминала и скриптов. В следующих версиях та же команда будет работать на dev-сервере.
Как запустить
Ничего настраивать не нужно: при запуске приложение само кладёт команду в PATH. Откройте новое окно терминала и наберите:
omut-cli status
Команда доступна и во встроенном терминале Omut (кнопка Терминал в панели сайта) — там она есть сразу, без новых окон.
Куда она ставится
- macOS — ссылка
~/.local/bin/omut-cliна файл внутри приложения. Обновится приложение — обновится и команда. - Linux — копия в
~/.local/bin/omut-cli. У AppImage путь запуска временный, поэтому нужна именно копия; после обновления приложения она перезаписывается. - Windows — в пользовательский PATH добавляется каталог приложения (
%LOCALAPPDATA%\Programs\Omut). Новые окна консоли видят команду сразу, уже открытые — только после перезапуска.
Если каталога ~/.local/bin не было в PATH, Omut добавит его одним помеченным блоком в файл настроек вашей оболочки (~/.zshrc, ~/.bashrc, ~/.profile или ~/.config/fish/conf.d/omut.fish). Блок помечен комментариями # >>> omut cli >>> и # <<< omut cli <<<, повторные запуски приложения его не дублируют, а остальные строки файла Omut не трогает — в том числе если файл omut.fish вы завели сами. Выключение переключателя убирает только этот блок.
Состояние команды видно в Настройках → Приложение: куда установлена, какой файл оболочки правился, и кнопка Установить для повтора вручную.
Как убрать команду
Выключите переключатель Команда omut-cli в терминале в Настройках → Приложение: Omut уберёт ссылку (на Windows — запись в PATH) и свой блок из файла оболочки и больше не будет ставить её при запуске.
Если по пути ~/.local/bin/omut-cli уже лежит чужой файл — например, ваша собственная ссылка на другую сборку, — Omut его не тронет и покажет причину в настройках: уберите файл сами или добавьте путь к команде в PATH вручную. То же и когда файл подменили уже после установки: Omut запоминает, что именно он положил, и чужое не перезаписывает.
На Windows Omut снимает из PATH только свою запись. Если каталог приложения был там до установки (прописали руками или оставил прежний установщик), выключение переключателя его не тронет.
Что умеет
| Команда | Результат |
|---|---|
omut-cli status | состояние nginx, PHP, MySQL, DNS и Pro-служб |
omut-cli doctor | диагностика: резолвер .bitrix, сертификат, порты, компоненты, папки |
omut-cli site list | сайты, их версии PHP/MySQL и статус установки |
omut-cli site create <имя> --php 8.3 | создать сайт (окружение должно быть запущено) |
omut-cli site export <имя> --write | записать манифест окружения omut/site.yaml в папку сайта |
omut-cli logs fetch --source nginx_error --site shop | последние строки журнала; ответ содержит курсор для дочитывания |
omut-cli logs tail --source php_fpm | следить за журналом в реальном времени |
omut-cli job list | долгие операции: установка, клон, импорт дампа, бэкап |
omut-cli env start / omut-cli env stop | запустить или остановить окружение, когда приложение Omut закрыто. Адреса .bitrix обслуживает приложение, поэтому без него env start откажет — добавьте --without-dns, если сайты по этим адресам сейчас не нужны |
Добавьте --json к любой команде, чтобы получить машиночитаемый ответ — удобно для скриптов и CI. omut-cli --help покажет все параметры.
Прогресс
Долгие операции — например, omut-cli site create shop --mode auto — показывают в терминале ту же полосу, процент и этап, что окно создания сайта в приложении: одной обновляемой строкой. Если вывод идёт в файл или в CI, каждый новый этап печатается отдельной строкой без управляющих символов.
С --json прогресса нет — в выводе только результат. С --verbose вместо полосы печатаются сырые события ядра JSON-строками, как и раньше.
Коды выхода
0 — успех, 1 — ошибка, 2 — неверные аргументы, 3 — указана цель, которой пока нет (--target появится с dev-серверами), 4 — сайт или задача не найдены.
Манифест окружения omut/site.yaml
Команда omut-cli site export (или действие Сохранить omut/site.yaml в панели сайта) записывает в папку сайта файл с версиями PHP и MySQL, режимом роутинга, HTTPS, debug и cron-агентами. Его можно закоммитить в репозиторий проекта: по нему Omut в следующих версиях поднимет такое же окружение у коллеги и на dev-сервере. Паролей в файле нет.
Проверить файл после ручных правок: omut-cli site validate путь/к/omut/site.yaml.