Встроенный SSH клиент в PhpStorm

Последнее обновление: 01.03.2019 г.
Публикация: 01.03.2019 г.
Информация

В этом руководстве описываются особенности использования встроенного SSH клиента в PhpStorm и удалённая работа с внешними инструментами по SSH.


Все действия, описанные здесь, были воспроизведены с корректными ожидаемыми результатами на PhpStorm 2016.2 под OS Windows 10 x64 Pro. Прежде чем продолжить, убедись, что у тебя есть доступ к какому-нибудь серверу по SSH.

Заметка

SSH — это утилита и защищённый сетевой протокол для удалённого доступа к операционной системе компьютера, является основным средством для администрирования. С его помощью можно передавать, изменять файлы и каталоги, перезагружать сервер и многое другое.

Изучение основ использования протокола SSH и одноимённой утилиты не входит в рамки данного руководства.

1. Использование встроенного SSH клиента

Чтобы начать работу со встроенным SSH клиентом в PhpStorm тебе необходимо запустить SSH соединение. Для этого с помощью главного меню IDE выбери пункт [Tools → Start SSH session...]. Откроется список Select host to connect (выбери хост для подключения).

PhpStorm: список "Select host to connect"

Если ранее ты уже настраивал, например, деплой, то увидишь существующие подключения в списке, в данном случае это dev и prod. Чтобы создать новое подключение и сохранить его конфигурацию, перейди через пункт главного меню IDE [Tools → Deployment → Configuration...] в диалоговое окно Deployment. Все созданные здесь подключения с типом соединения SFTP далее будут отображаться в списке Select host to connect.

Чтобы создать одноразовое подключение, выбери пункт Edit credentials... (изменить учётные данные), откроется диалоговое окно SSH Session, как на скриншоте ниже. В нём укажи всю информацию о подключении: хост (локальный или удалённый), порт, имя пользователя и пароль.

PhpStorm: окно "SSH Session"

После ввода необходимых данных и нажатия кнопки ОК запускается SSH сессия в отдельной вкладке окна инструмента Terminal, в нижней панели окна инструментов.

PhpStorm: окно инструмента "Terminal"

Что можно делать в SSH сессии? Как обычно, в интерактивной сессии можно: запускать удалённо любые команды, копировать и вставлять, прокручивать историю команд с помощью клавиш со стрелками вверх и вниз.


2. Работа с внешним инструментом по SSH

Теперь определи внешний инструмент, который будет, например, показывать календарь и выполнять команду по SSH.


2.1. Настройка внешнего инструмента для доступа по SSH

С помощью пункта главного меню IDE [File → Settings... → Tools → Remote SSH External Tools] ты попадёшь в нужный подраздел, где с помощью кнопки, в форме плюсика, на панели инструментов ты можешь создать новый удалённый инструмент.

Заметка

Дополнительные сведения по вопросу создания нового удалённого инструмента ты можешь получить из следующей справки PhpStorm: Внешние SSH инструменты.

В диалоговом окне Create Tool (скриншот ниже) укажи параметры нового инструмента:

  • Поле Name — это видимое имя нового инструмента.
  • Необязательное поле Description — это какое-нибудь осмысленное описание инструмента.
  • Необязательное поле Group — это имя группы, которая будет создана в меню Tools, и новый внешний SSH инструмент будет расположен в этой группе.
  • Область Tool Settings содержит все настройки для инструмента, который будет выполняться удалённо. На скриншоте ниже используется Bash команда cal. Поле Arguments (аргументы) и поле Working directory (рабочий каталог) не обязательны к заполнению. Также ты можешь использовать макросы для ввода параметров инструмента.
  • Область Connection settings содержит различные переключатели. Используй переключатель Deployment server и выбери из списка пункт Select server on every run. Он означает, что каждый раз при запуске удалённого инструмента, необходимо выбирать какое подключение к серверу будет использовано.
PhpStorm: окно "Create Tool"

Нажми кнопку ОК, чтобы закрыть диалоговое окно Create Tool (создать инструмент) и вернуться в подраздел Remote SSH External Tools. Теперь в нём ты увидишь новый инструмент в списке.

PhpStorm: окно настроек раздела "Remote SSH External Tools"

2.2. Запуск внешнего инструмента по SSH

После создания или настройки инструмента он отобразится в ранее указанном меню. В данном случае это меню Tools, также инструмент будет находиться в группе, определённой ранее.

Используй пункт главного меню PhpStorm [Tools → Auxiliary Tools → show calendar] и посмотри, что получится. После клика выбери существующее подключение или укажи параметры для одноразового подключения. Сделай правильный выбор.

И, наконец, ты увидишь календарь!

PhpStorm: окно инструмента "Run"

3. О встроенном локальном терминале*

Терминал в PhpStorm под Windows по умолчанию использует интерпретатор командной строки Cmd.exe. Функциональность встроенного локального терминала можно увеличить с помощью, использования Git Bash, ты ведь наверняка используешь Git. Если всё так, то с помощью пункта главного меню IDE [File → Settings... → Tools → Terminal] перейди в настройки подраздела Terminal. В нём есть параметр Shell path (путь к шеллу), в секции Application settings (настройки приложения), значение которого тебе нужно изменить, например, на следующее:

C:\Program Files\Git\bin\bash.exe

Заметка

Дополнительную информацию по улучшению функциональности терминала ты можешь найти в материалах 2-х последних ссылок блока Источники данного руководства.

Пункт является опциональным при изучении руководства: Встроенный SSH клиент в PhpStorm.

Контрольные вопросы

Источники и дополнительные материалы