PhpStorm
 
2023.2
Shortcuts: Windows
Get PhpStorm
You are viewing the documentation for an earlier version of PhpStorm.
  1. Reference
  2. Settings
  3. Tools
  4. PHP Command Line Tool Support

PHP Command Line Tool Support

Last modified: 29 September 2023

Windows and Linux: File | Settings | Tools | PHP Command Line Tool Support

macOS: PhpStorm | Preferences | Tools | PHP Command Line Tool Support

CtrlAlt0S or the Settings button

PhpStorm supports running commands of popular third-party or user-defined PHP tools: Symfony 1.1+, Symfony2, Zend Framework 1, Zend Framework 2 (ZFTool), Yii, Composer, Drush 5.8+, Laravel and Doctrine (Symfony console-based), WordPress Command Line Interface.

Enable the PHP Command Line Tool Support plugin

This functionality relies on the PHP Command Line Tool Support plugin, which is bundled and enabled in PhpStorm by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

  1. Press CtrlAlt0S to open the IDE settings and then select Plugins.

  2. Open the Installed tab, find the PHP Command Line Tool Support plugin, and select the checkbox next to the plugin name.

The page shows a list of all PHP-specific and custom command line tools integrated with PhpStorm. Tools with inconsistencies in the .xml descriptor are marked with the Warning icon. For more information, refer to PHP command line tools.

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

Alias

In this field, 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, and c for Composer.

Interpreter

This read-only field displays the path of the PHP engine for the local or remote PHP interpreter, through which the tool commands are executed. For more information about configuring PHP interpreters, refer to Configure local PHP interpreters and Configure remote PHP interpreters.

Tool Path

In this field, 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.

the Add button

Add

AltInsert

Click this button to open the Command Line Tools dialog and select the tool to integrate with PhpStorm. Depending on your choice, PhpStorm opens one of the following dialogs for specifying the location of the selected tool:

the Remove button

Remove

AltDelete

Click this button to remove the selected tool from the list.

the Edit button

Edit

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

the Reload command list from executable button

Reload command list from executable

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

the Edit Source button

Open definition in editor

Click this button to open the .xml file with commands of the selected tool in the editor. See Define your own command line tool.

See also

Procedures