IntelliJ IDEA 2019.3 Help

Running SSH Terminal

You can launch an SSH Session right from IntelliJ IDEA. By running commands in a dedicated SSH terminal, you can access data on a remote Web server or a Vagrant instance (virtual machine) via an SSH tunnel, mainly upload and download files.

Prepare to work in the SSH Terminal

  1. Make sure the SSH Remote Run bundled plugin is enabled. If the plugin is disabled, activate it as described in Managing plugins.

  2. Make sure an SSH server is available in the destination environment: a remote Web server or a Vagrant instance (virtual machine).

  3. Register an account on the SSH server in the destination environment and generate a pair of SSH keys or a password, depending on the server policy.

  4. Appoint the destination environment and specify the settings to establish connection with it:

    1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Tools | SSH Terminal .

    2. In the Connection settings area, appoint the destination environment:

      • Current Vagrant: select this option to have the commands in the SSH Terminal executed on the currently running Vagrant virtual machine.

      • Deployment server: select this option to have the commands in the SSH Terminal executed on the local or remote Web server accessible through one of the server access configurations. From the list, choose the server access configuration that specifies the destination environment and the settings to establish connection to it.

        • Select server on every run: if this option is selected, you will have to choose the desired server access configuration from the popup, every time you choose Tools | Start SSH Session from the main menu.

        • If the desired server access configuration does not appear in the list, click the link Configure Servers, and define one in the Deployment page. For details, see the Configuring Synchronization with a Remote Host section.

    3. From the Default encoding list, select the desired encoding to be used in the SSH terminal.

Launch the SSH Terminal

  1. From the main menu, choose Tools | Start SSH Session. Alternatively, invoke the Help | Find Action Ctrl+Shift+A dialog, search for start ssh.., and select Start SSH Session.

  2. Depending on the connection settings, defined in on the Tools | SSH Terminal page of the Settings/Preferences dialog Ctrl+Alt+S, the following types of behavior are possible:

    • If the Current Vagrant option has been selected, the SSH Terminal will provide access to the currently running Vagrant virtual machine. For details, see Vagrant.

    • If the option Deployment server has been selected, the SSH Terminal will provide control over the data on the local or remote Web server accessible through the server access configuration selected from the list. For details, see Configuring Synchronization with a Web Server.

    • If the option Select server on every run has been selected, IntelliJ IDEA will show a list to choose the desired server access configuration from.

Last modified: 9 December 2019