PyCharm 2023.2 Help

Create SSH configurations

In PyCharm, you can save the remote server SSH connection parameters as a dedicated SSH configuration. The created configuration can be then used for configuring remote interpreters, connecting to SFTP deployment servers, and launching SSH sessions.

  1. In the Settings dialog (Control+Alt+S), go to Tools | SSH Configurations.

  2. In the left-hand pane that lists all the existing SSH configurations, click Add item.

  3. Use the Visible only for this project checkbox to configure the visibility of the server access configuration.

    • Select the checkbox to restrict the use of the SSH configuration to the current project. Such SSH configuration cannot be reused outside the current project. It does not appear in the list of available configurations in other projects.

      The SSH configurations are stored in the .idea directory together with the project, which allows sharing them between team members through a VCS.

    • When the checkbox is cleared, the SSH configuration is visible in all PyCharm projects. Its settings can be reused across several projects.

  4. In the Host, User name, and Port fields, specify the connection parameters. Local port is used only with the Database Tools and SQL plugin to establish a connection to a remote database.

  5. Choose the way to authenticate to the server. Do one of the following:

    • Password: Access the host with a password. To save the password in PyCharm, select the Save password checkbox.

    • Key pair (OpenSSH or PuTTY): Use SSH authentication with a key pair. To apply this authentication method, you must have a private key on the client machine and a public key on the remote server. PyCharm supports private keys that are generated with the OpenSSH utility.

      Specify the path to the file where your private key is stored and type the passphrase (if any) in the corresponding fields. To have PyCharm remember the passphrase, select the Save passphrase checkbox.

    • OpenSSH config and authentication agent: Use a credentials helper application that manages your SSH keys, such as ssh-agent.

    For more information about working with SSH keys, refer to the Generating a new SSH key and adding it to the ssh-agent tutorial.

    If you select the OpenSSH config options, PyCharm parsers OpenSSH directives recorded in SSH config file: /etc/ssh/ssh_config> and ~/.ssh/config on Linux and macOS, or C:\Users\<username>\.ssh\config on Windows. PyCharm supports a limited set of OpenSSH directives.

  6. Click the Test Connection button to make sure that the settings are correct and PyCharm can connect to the target server.

Supported OpenSSH directives

Last modified: 05 September 2023