WebStorm 2018.3 Help

Command Line Tool Support

File | Settings | Command Line Tool Support for Windows and Linux
WebStorm | Preferences | Command Line Tool Support for macOS
Ctrl+Alt+S icons general settings svg

This page is available only when the Command Line Tool Support plugin is installed and enabled as described in Managing 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.

Item

Tooltip and shortcut

Description

Enabled

When the checkbox in this column is selected, the commands defined within the corresponding command line tool can be executed from WebStorm.

Alias

In this text box, specify the character string to use in command calls instead of the full path to the tool.

Tool Path

In this text box, specify the location of the tool's executable file.

Type

This 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 type

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

Console encoding

From this drop-down list, choose the character set to show the tool's output in the Command Line Tools Console Tool Window.

icons general add svg

Add
Alt+Insert

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.

icons general remove svg

Remove
Alt+Delete

Click this button remove the selected tool from the list.

icons actions edit svg

Edit

Click this button to change the definition file of the selected tool.

icons actions refresh svg

Reload command list from executable

Click this button to refresh the list of commands of the selected tool.

icons actions edit svg

Open definition in editor

Click this button to open the .xml file with commands of the selected tool in the editor.

Last modified: 6 December 2018

See Also