Configure Node.js Remote Interpreter Dialog
This feature is supported in the Professional edition only.
The dialog box is available only when the Node.js Remote Interpreter plugin is enabled. The plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
The dialog box opens when you click the Add toolbar button in the Node.js Interpreters Dialog and choose Remote... from the drop-down menu. This menu item is available only when you open the Node.js Interpreters Dialog from the Run/Debug Configuration: Node JS.
Use this dialog box to configure access to Node.js installations on remote hosts or in development environments set up in Vagrant instances.
Item | Description |
---|---|
SSH Credentials | Choose this option to configure access to a Node.js interpreter on a remote host through SSH credentials. In the fields of the dialog box, specify the following:
To use an interpreter configuration, you need path mappings that set correspondence between the project folders, the folders on the server to copy project files to, and the URL addresses to access the copied data on the server . PyCharm first attempts to retrieve path mappings itself by processing all the available application-level configurations. If PyCharm finds the configurations with the same host as the one specified above, in the Host field, the mappings from these configurations are merged automatically. If no configurations with this host are found, PyCharm displays an error message informing you that path mappings are note configured. To fix the problem, open the Deployment page under the Build, Execution, Deployment node, select the server access configuration in question, switch to the Mappings tab, and map local folders to folders on the server as described in Creating a Remote Server Configuration, section Mapping Local Folders to Folders on the Server and the URL Addresses to Access Them. |
Vagrant | This option is available only when the Vagrant repository plugin is installed and enabled. The plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins. Choose this option to configure access to a Node.js interpreter installed in a Vagrant instance using your Vagrant credentials. Technically, it is the folder where the VagrantFile configuration file for the desired environment is located. Based on this setting, PyCharm detects the Vagrant host and shows it as a link in the Vagrant Host URL read-only field. To use an interpreter configuration, you need path mappings that set correspondence between the project folders, the folders on the server to copy project files to, and the URL addresses to access the copied data on the server . PyCharm evaluates path mappings from the |
Deployment Configuration | This option is available only when the Remote Hosts Access plugin is enabled. The plugin is bundled with PyCharm and activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins. Choose this option to configure access to a Node.js interpreter on a remote host using a server access configuration. This option is available only if you have at least one server access configuration of the type SFTP, see Creating a Remote Server Configuration. From the Deployment Configuration drop-down list, choose the server access configuration of the type SFTP according to which you want PyCharm to connect to the target host. If the settings specified in the chosen configuration ensure successful connection, PyCharm displays the URL address of the target host as a link in the Deployment Host URL field. To use an interpreter configuration, you need path mappings that set correspondence between the project folders, the folders on the server to copy project files to, and the URL addresses to access the copied data on the server . By default, PyCharm retrieves path mappings from the chosen server access (deployment) configuration. If the configuration does not contain path mappings, PyCharm displays the corresponding error message. To fix the problem, open the Deployment page under the Build, Execution, Deployment node, select the relevant server access configuration, switch to the Mappings tab, and map the local folders to the folders on the server as described in Creating a Remote Server Configuration, section Mapping Local Folders to Folders on the Server and the URL Addresses to Access Them. |
Docker | This option is available only when the Node.js, Node.js Remote Interpreter, and Docker Integration plugins are enabled. The plugins are bundled with PyCharm and activated by default. If the plugins are not activated, enable them on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins. Choose this option to configure access to a Node.js interpreter running in a Docker container.
|
Node.js Interpreter Path | In this field, specify the location of the Node.js executable file in accordance with the configuration of the selected remote development environment. By default PyCharm suggests the /usr/bin/node folder for remote hosts and Vagrant instances and node for Docker containers. To specify another folder, click the Browse button and choose the relevant folder in the dialog box that opens. Note that the Node.js home directory must be open for edit. When you click OK, PyCharm checks whether the Node.js executable is actually stored in the specified folder.
|