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, or launching SSH sessions.
In the Settings dialog (Ctrl+Alt+S) , go to .
In the left pane, click
.Use the Visible only for this project checkbox to enable reuse of this server access configuration in other projects.
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.
Project-specific configurations are stored in the .idea directory. Review these files before sharing them through version control. Server configurations available to all projects are stored in the IDE settings.
When the checkbox is cleared, the SSH configuration is visible in all PyCharm projects. Its settings can be reused across several projects.
In the Host, Username, 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.
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 or Pageant (Windows only).
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.
Click the Test Connection button to make sure that the settings are correct and PyCharm can connect to the target server.
Supported OpenSSH directives
When you use OpenSSH config and authentication agent, PyCharm reads your SSH configuration files. Choose how to read them in .
The default OpenSSH option requires OpenSSH on your computer and runs ssh -G to read the configuration. PyCharm then applies the settings supported by its SSH implementation, not every OpenSSH feature.
The Legacy option uses the parser built into PyCharm, which supports the following directives: