WebStorm 2017.3 Help

Command Line Tool Support

File | Settings | Command Line Tool Support for Windows and Linux
WebStorm | Preferences | Command Line Tool Support for macOS


This page is available only when the Command Line Tool Support plugin is installed and enabled as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

WebStorm supports running commands of third-party or user-defined tools. Code completion and parameter hints are provided via a tool-specific XML descriptor.

The page shows a list of all custom command line tools integrated with WebStorm. Tools with inconsistencies in the .xml descriptor are marked with icon incorrect description.

ItemTooltip and shortcutDescription
EnabledWhen the checkbox in this column is selected, the commands defined within the corresponding command line tool can be executed from WebStorm.
AliasIn this text box, specify the character string to use in command calls instead of the full path to the tool.
Tool PathIn this text box, specify the location of the tool's executable file.
TypeThis read-only field shows the official name of the third party command line tool. The column is available only if the Show tool type checkbox is selected. For custom command line tools, the fields in this column are empty.
Show tool typeIf this checkbox is selected, the Type column is added to the table of available tools.
Show console in In this area, specify where you want to enter commands. The available options are:
  • Pop-up - choose this option to have the Command Line Tools Input pane opened in a separate pop-up window and type commands there.
  • Tool window - choose this option to enter commands in the Input field in the bottom of the dedicated Command Line Tools Console tool window.

Although WebStorm provides a tool window for running commands, it is strongly recommended that you use the built-in local Terminal instead.

Console encodingFrom this drop-down list, choose the character set to show the tool's output in the Command Line Tools Console Tool Window.
Click this button to open the Create Custom Tool dialog box. When you click Yes, WebStorm opens the Tool Settings dialog box for specifying the location of the new tool.
Click this button remove the selected tool from the list.
edit1EditClick this button to change the definition file of the selected tool.
refreshReload command list from executableClick this button to refresh the list of commands of the selected tool.
editOpen definition in editorClick this button to open the .xml file with commands of the selected tool in the editor.
Last modified: 28 December 2017

See Also