Run SSH terminal

Make sure an SSH server is available in the destination environment: a remote server or the default remote interpreter.

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.

warning

The RFC 4716 format for OpenSSH keys is not supported by PyCharm.

See the workaround.

Appoint the destination environment and specify the settings to establish connection with it:

1. In the Settings 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.

   • Default remote interpreter: select this option to have commands in the SSH terminal executed on the same host, where the default remote interpreter runs.

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

From the main menu, choose Tools | Start SSH Session. Alternatively, invoke the Help | Find Action Ctrl+Shift+A dialog, search for start ssh.., and select Start SSH Session.

Depending on the connection settings, defined in on the Tools | SSH Terminal page of the Settings dialog (Ctrl+Alt+S), the following types of behavior are possible:

• If the Default remote interpreter option has been selected, the SSH terminal will provide access to the same host, where the default remote interpreter runs.

• If the Current Vagrant option has been selected, the SSH Terminal will provide access to the currently running Vagrant virtual machine.

  For details, see Vagrant: Working with Reproducible Development Environments.

• 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, PyCharm will show a list to choose the desired SSH configuration from.