PyCharm 2017.3 Help

Configuring Remote Interpreters via SSH

This feature is supported in the Professional edition only.

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 /help/img/idea/2017.3/cogwheel_framed.png.
  2. From the drop-down list, choose Add Remote.
    /help/img/idea/2017.3/py_remote_interpreter_choose.png

    The dialog box Configure Remote Python Interpreter opens.

  3. In the dialog box Configure Remote Python Interpreter, click the radio-button SSH credentials:
    /help/img/idea/2017.3/py_configure_remote_interpreter.png
  4. In the Configure Remote Python Interpreter dialog box, fill in the server information (host, port, etc.)

    Note the Auth type field. It suggests the following options: Password, Key pair and Authentication agent. If you choose one of the first two options, you should have to enter your password or passphrase. However, the last option allows you to use the authentication agents ssh-agent or Pageant.

  5. The Python interpreter path field displays the path to the desired Python executable. You can accept default, or specify a different one.
  6. Click OK in the Configure Remote Python Interpreter dialog box. The configured remote interpreter is added to the list.
  7. Back in the Project Interpreter page, if necessary, configure the path mappings:
    1. Click /help/img/idea/2017.3/browseButton.png:
      /help/img/idea/2017.3/py_edit_path_mapping.png
    2. In the dialog box that opens add (/help/img/idea/2017.3/add.png) or delete (/help/img/idea/2017.3/delete.png) path mappings as desired.

See Also

Last modified: 15 September 2017