WebStorm 2016.3 Help

Create/Edit/Copy Tool Dialog (Remote SSH External Tools)

From the Remote SSH External Tools page: /help/img/idea/2016.3/new.png, /help/img/idea/2016.3/editFlexLibraryNew.png or /help/img/idea/2016.3/copy.gif


Edit the settings for your external tool.

ItemDescription
Name The name of the tool that appears as a command name in the Tools menu and the context menus. See also, Show in.
Group The group the tool belongs to. The tool groups correspond to submenus in the Tools menu and the context menus.

Select an existing group from the list or type the name for a new group.

Description The tool description (optional).
Options
Synchronize files after execution Make WebStorm aware of changes in the file system when the tool completes its execution.
Open console Open the console for viewing the tool output such error messages, etc.
Output Filters Open the Output Filters dialog to manage the output filters associated with the tool.

(The output filters are used to turn absolute file paths and line numbers in the tool output into hyperlinks. You'll be able to use those links to open the corresponding files in the editor.)

Show console when a message is printed to standard output stream Make the output console active and bring it forward when the corresponding event occurs.
Show console when a message is printed to standard error stream The same as the previous option but for stderr.
Show in Specify in which menus the command for running the tool should be included. Main menu means the Tools menu. The rest of the options correspond to context menus in various places.
Connection settingsIn this section, appoint the to access through the SSH terminal and specify where the connection settings should be taken from:
  1. Current Vagrant: select this option to have the commands in the SSH Terminal executed on the currently running Vagrant virtual machine. For details, see Vagrant: Working with Reproducible Development Environments.
  2. Deployment server: select this option to have the commands in the SSH Terminal executed on the local or remote Web server accessible through one of the server access configurations. From the drop-down list, choose the server access configuration that specifies the destination environment and the settings to establish connection to it.
    • Select server on every run: if this option is selected, you will have to choose the desired server access configuration from the pop-up window, every time you choose Tools | Start SSH Session on the main menu.
    • If the desired server access configuration does not appear in the drop-down list, click the link Configure Servers, and define one in the Deployment page. For details, see Configuring Synchronization with a Web Server.
Tool settings
Program The path to the executable file to be run. Use /help/img/idea/2016.3/browseButton.png to select the file, Insert macro to open the Macros dialog to select a macro.

(Macros are resolved at runtime and let you specify context information such as currently selected file, your project source paths, etc.)

Parameters The parameters to be passed to the program the way you'd specify them on the command line. Use Insert macro to open the Macros dialog to select a macro.

When specifying the parameters, follow these rules:

  • Use spaces to separate individual parameters.
  • If a parameter includes spaces, enclose the spaces or the argument that contains the spaces in double quotes, for example, some" "arg or "some arg".
  • If a parameter includes double quotes (e.g. as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".
Working directory The path to the current working directory for the program. Use /help/img/idea/2016.3/browseButton.png to select the directory, Insert macro to open the Macros dialog to select a macro.

See Also

Last modified: 1 December 2016