JetBrains Rider
 
2023.1
Shortcuts: Visual Studio 2022 (Windows)
Get JetBrains Rider
You are viewing the documentation for an earlier version of JetBrains Rider.
  1. Streamline your work with JetBrains Rider
  2. Run SSH terminal

Run SSH terminal

Last modified: 21 April 2023

Add SSH configurations: Settings/Preferences | Tools | SSH Configurations

Start an SSH session from the main menu: Tools | Start SSH Session

Configure SSH terminal: Settings/Preferences | Tools | SSH Terminal

warning

The following is only valid when the SSH Remote Run plugin is installed and enabled.

You can launch an SSH Session right from JetBrains Rider. 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 an SSH server is available in the destination environment: a remote Web server or a Vagrant instance (virtual machine).

  2. 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.

  3. 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.

      • SSH configuration: select this option to have the commands in the SSH Terminal executed on the local or remote Web server accessible through one of the SSH configurations.

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

        • If the desired SSH configuration does not appear in the list, click the Set up configurations link, and define one in the SSH Configurations page.

    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+Q 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 SSH configuration option has been selected, the SSH Terminal will provide control over the data on the server accessible through the SSH configuration selected from the list. For details, see Create SSH configurations.

    • If the Select SSH configuration on every run option has been selected, JetBrains Rider will show a list to choose the desired SSH configuration from.