PyCharm 2018.2 Help

Configuring Remote Interpreters via SSH

Prerequisites

  • A ssh server should run on a remote host, since PyCharm runs remote interpreter via ssh-session.
  • If you want to copy your sources to a remote computer, create a deployment configuration, as described in the section Creating a Remote Server Configuration.

Configuring remote Python interpreter via SSH credentials

To configure a remote Python interpreter via SSH credentials

  1. In the Project Interpreter page of the Settings/Preferences dialog box, click icons general gearPlain svg.
  2. From the drop-down list, choose Add.
    py interpreter add

    The dialog box Add Python Interpreter opens.

  3. In the left-hand pane of the Add Python Interpreter dialog box, click SSH Interpreter.
  4. In the right-hand pane select New server configuration, then specify server information (host, port, and username).
    adding an interpreter via SSH
    Alternatively, you can select Existing server configuration and choose any available deployment configuration from the list.
    py existing ssh configuration
    If needed, click browseButton to review the Connection settings, Mappings, and Excluded paths for the selected deployment configuration. Click Next to continue configuring an interpreter.
  5. In the next dialog window, provide the authentication details to connect to the target server.
    specifying authentication details

    Select Password or Key pair (OpenSSL or PuTTY) and enter your password or passphrase.

    Click Next to proceed with the final configuration step.
  6. In the next dialog window, verify the path to the desired Python interpreted. You can accept default, or specify a different one. You have to configure the path mappings between your local project and the server. To do that, click browseButton next to the Sync folders field and enter the path to the local project folder and the path to the folder on the remote server.

    py interpreter ssh mappings

    You can also select two checkboxes to upload local project directories to the remote server and to enable automatic upload of the local changes to the remote server.

  7. Click Finish to complete adding an interpreter.
Last modified: 20 July 2018

See Also