Studio CLI

Что такое Studio CLI?

Studio CLI — это глобально доступная утилита командной строки для взаимодействия с функциями WordPress Studio из терминала. Она разработана для работы даже при закрытом приложении Studio и используется для управления локальными сайтами Studio и preview-средами, размещёнными на WordPress.com.

CLI можно установить вместе со Studio (идёт в комплекте) или использовать как отдельный npm-модуль wp-studio. Основная цель — управление задачами, связанными со Studio (создание preview-сайтов, обновление и аутентификация), из скриптов и шагов сборки.

Основные возможности

• Глобальная команда терминала (studio): Выполняйте действия Studio откуда угодно без необходимости держать Studio открытым.
• Структурированный синтаксис команд (studio <area> <command> [options]): Применяйте предсказуемые шаблоны для рабочих процессов сайтов и preview.
• Целевое указание пути (--path): Направляйте команды на конкретную директорию сайта Studio вместо использования текущей рабочей директории.
• Управление аутентификацией WordPress.com: Используйте studio auth login, studio auth logout и studio auth status для подключения действий CLI к аутентифицированному аккаунту WordPress.com при необходимости.
• Операции с preview-сайтами: Создавайте, просматривайте, обновляйте и удаляйте временные preview-сайты на WordPress.com с помощью команд вроде studio preview create, studio preview list, studio preview update и studio preview delete.
• Команды управления локальными сайтами: Управляйте локальными сайтами Studio (статус, создание, список, запуск, остановка, удаление и настройка) из терминала с помощью команд studio site ....

Как использовать Studio CLI

1. Включите Studio CLI в приложении Studio (рекомендуется, если вы уже используете Studio):

   • Откройте приложение “WordPress Studio”.
   • В главном меню откройте модальное окно Settings (или кликните на значок шестерёнки).
   • Включите “Studio CLI” и кликните Save.
   • На macOS может потребоваться ввести пароль учётной записи для установки.

2. Откройте терминал и проверьте доступность:

   • Выполните studio --help, чтобы увидеть обзор.

3. Аутентифицируйтесь для задач, требующих доступа к WordPress.com (например, preview-сайты):

   • Выполните studio auth login.
   • Команда откроет браузерный процесс; вы получите токен аутентификации для вставки в терминал.
   • Проверьте с помощью studio auth status.

4. Создайте и поделитесь preview-сайтом из локального сайта Studio:

   • Из корня локального сайта Studio выполните:

     cd /path/to/your/studio-site
     studio preview create
     

   • CLI соберёт и загрузит локальный сайт в preview-среду и вернёт URL для分享.

5. Обновляйте или удаляйте preview по имени хоста:

   • Просмотрите preview с помощью studio preview list, чтобы получить идентификатор host.
   • Обновление:

     studio preview update <host>
     

   • Удаление:

     studio preview delete <host>
     

6. Укажите другую директорию сайта при необходимости:

   • Добавьте --path /path/to/site к командам вместо смены директорий:

     studio preview create --path /path/to/your/studio-site
     

Сценарии использования

• Управление локальными сайтами Studio без выхода из терминала: Используйте studio site status, studio site start, studio site stop и studio site list для контроля локальных сред в сценариях с интенсивным использованием скриптов.

• Создание preview-сред для分享 с коллегами или заинтересованными сторонами: Выполните studio preview create из корня локального сайта Studio, чтобы получить временный preview-URL, размещённый на WordPress.com.

• Итерации над preview по мере внесения изменений: После создания preview используйте studio preview update <host> для пересборки и переразвёртывания изменений из локального сайта в существующую preview-среду.

• Очистка preview-сред: Используйте studio preview delete <host> для полного удаления preview-сайта, когда он больше не нужен.

• Автоматизация рабочих процессов Studio в шагах сборки: Используйте команды studio в скриптах для интеграции задач вроде создания/обновления preview и управления сайтами в конвейер разработки.

FAQ

Нужно ли держать приложение Studio открытым для Studio CLI? Нет. Studio CLI предназначена для взаимодействия с функциями Studio из терминала независимо от того, открыт Studio или нет.

Как указать команду на конкретную директорию сайта Studio? Большинство команд предполагают запуск из корня сайта, управляемого Studio. Если нет — используйте опцию --path (например, studio preview create --path /path/to/site).

Что происходит при выполнении команды preview без входа в систему? Команды, требующие аутентификации (например, studio preview create), вернут ошибку и подскажут войти в систему.

Как найти имя хоста preview для обновления/удаления? Выполните studio preview list, чтобы увидеть связанные preview и их значения host. Используйте этот host с studio preview update <host> или studio preview delete <host>.

Откуда берётся информация аутентификации для studio auth login? Команда запускает браузерный процесс для подключения CLI к аккаунту WordPress.com, затем предоставляет токен для вставки в терминал и завершения процесса.

Альтернативы

• Ручная работа в интерфейсе Studio: Если автоматизация в терминале не нужна, прямое использование приложения Studio позволит создавать превью и управлять локальными сайтами без интеграции CLI.
• Общие инструменты командной строки для WordPress (например, WP-CLI + пользовательские скрипты): Если специфические для Studio превью-среды не требуются, можно комбинировать инструменты командной строки WordPress со своими скриптами для управления задачами сайтов, хотя хостинг превью и функции Studio могут не поддерживаться.
• Другие подходы к оркестрации локального WordPress: Вместо команд управления сайтами Studio можно использовать другие локальные установки WordPress (контейнеризованные или скриптовые) и обрабатывать превью отдельными шагами развертывания, но с потерей единого рабочего процесса Studio CLI для превью/обновления/удаления и сайтов под управлением Studio.