Creating a Command Line Tool
On this page:
Introduction
The command line tools that are available from PhpStorm are listed in the Command Line Tool Support page of the Settings/Preferences dialog box. Integration with command line tools is provided at the PhpStorm level, so once configured, a tool can be used in all your PhpStorm projects. Just activate and de-activate when necessary depending on the needs of each specific project.
You can update the command definitions of a tool and have the .xml definition file validated right in the PhpStorm editor.
Note that PHP-specific command line tools work only with local PHP interpreters, see Configuring Local PHP Interpreters and Configuring Remote PHP Interpreters.
Creating and configuring a command line tool
To create and configure a command line tool
- Open the PhpStorm settings and click Command Line Tool Support.
- In the Command Line Tool Support page, click
. In the Command Line Tools dialog box that opens, choose visibility level of the tool (project or global), and its type from the Choose tool drop-down list. - In the dialog box that opens, specify tool name and location, and the other required parameters.
When you click OK, PhpStorm brings you to the Command Line Tool Support page, where the new tool is added to the list of available tools.
- Select the newly created tool and click
. In the tool definition .xmlfile that opens in the editor, define the tool commands. - In the Show console in area, specify where you want the Input pane for typing commands opened:
- To have the Input pane opened in a pop-up window, choose the Pop-up option.
- To have the Input pane opened as a text box at the bottom of the Command Line Tools Console tool window, choose the Tool window option.
Activating a configured command line tool
To activate a configured command line tool
- Open the PhpStorm settings, and then click Command Line Tool Support.
- Select the Enable check box next to to the tool name.