PhpStorm 2017.1 Help

Command Line Tool Support

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


PhpStorm supports running commands of Zend Framework Tool, Symfony, and other third-party and custom tools. PhpStorm provides completion and parameter info via an XML descriptor.

The page shows a list of all PHP-specific and custom command line tools that are currently available at the PhpStorm level.

This page shows a list of all PHP-specific and custom command line tools that are currently available at the PhpStorm level.

Tools with inconsistencies in the definition files are marked with the Invalid description icon /help/img/idea/2017.1/icon_incorrect_description.png.

Note that PHP-specific command line tools work only with local PHP interpreters, see Configuring Local PHP Interpreters and Configuring Remote PHP Interpreters.

ItemTooltip and shortcutDescription
Table of available tools
EnabledWhen the check box in this column is selected, the commands defined within the corresponding command line tool can be executed from PhpStorm.
AliasIn a text box in this column, specify the character string to use in command calls instead of the full path to the tool.

For example, by default, PhpStorm assigns the following aliases:

  • s for Symfony.
  • zf for Zend Framework.
  • c for Composer.

Tool PathIn a text box in this column, specify the location of the tool's executable file.
TypeA read-only field in this column shows the official name of the third party command line tool.
  1. The column is available only if the Show tool type check box is selected.
  2. For custom command line tools, the fields in this column are empty.
Click this button to open the Command Line Tools dialog box and select the type of command-line tool to enable integration with. The available options are:
  • Custom Tool
  • Zend Framework 1 Tool
  • Zend Framework 2 Tool
  • Symfony
  • Composer
  • Drush
  • Tool based on Symfony Console

Depending on your choice, PhpStorm opens one of the following dialog boxes for specifying the location of the selected tool:

Click this button to have the selected tool removed from the list.
/help/img/idea/2017.1/edit1.pngEditClick this button to change the definition of the selected tool.
/help/img/idea/2017.1/refresh.pngReload command list from executableClick this button to have PhpStorm refresh the list of commands of the selected tool.
/help/img/idea/2017.1/edit.pngOpen definition in editorClick this button to have PhpStorm open the .xml file with commands of the selected tool in the editor.
Show tool typeIf this check box is selected, the Type column is added to the table of available tools.
Show console inIn 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 encodingFrom this drop-down list, choose the character set to show the tool's output in the Command Line Tools Console Tool Window.

See Also

Last modified: 19 July 2017