Command-line interface

The installation directory contains batch scripts and executables for launching PhpStorm, formatting the source code, and running inspections. To use them from the Command Prompt cmd.exe, add the location of the PhpStorm bin folder to the PATH environment variable. For example, if you installed PhpStorm to C:\Program Files\JetBrains\PhpStorm, you can use the following command:

>
set PATH=%PATH%;C:\Program Files\JetBrains\PhpStorm\bin

This command changes the PATH environment variable for the current shell only (the current instance of cmd.exe). If you want to update it permanently for the current user, run setx:

>
setx PATH "%PATH%;C:\Program Files\JetBrains\PhpStorm\bin"

To update it system-wide for all users, run setx /M instead of setx.

tip

The installer can do this for you if you select Add launchers dir to the PATH on the Installation Options step of the setup wizard.

After you configure the PATH variable, you can run the executable from any working directory in the Command Prompt: phpstorm64.exe. Alternatively, you can use the batch script: phpstorm.bat.

To run PhpStorm from the shell, use the open command with the following options:

• -a: specify the application.

• --args: specify additional arguments when passing more than just the file or directory to open.

• -n: open a new instance of the application even if one is already running.

For example, you can run PhpStorm.app with the following command:

$
open -na "PhpStorm.app"

note

If PhpStorm is not in the default /Applications directory, specify the full path to it.

You can create a shell script with this command in a directory from your PATH environment variable. For example, create the file /usr/local/bin/phpstorm with the following contents:

#!/bin/sh

open -na "PhpStorm.app" --args "$@"

Make sure you have permissions to execute the script and since /usr/local/bin should be in the PATH environment variable by default, you should be able to run phpstorm from anywhere in the shell.

On Linux, the installation directory contains the launcher shell script phpstorm.sh under bin. For example, if you installed PhpStorm to /opt/phpstorm, you can run the script using the following command:

$
/opt/phpstorm/bin/phpstorm.sh

You can create a symbolic link to the launcher script in a directory from the PATH environment variable. For example, if you installed PhpStorm to /opt/phpstorm and want to create a link named phpstorm in /usr/local/bin, run the following command:

$
ln -s /opt/phpstorm/bin/phpstorm.sh /usr/local/bin/phpstorm

Since /usr/local/bin should be in the PATH environment variable by default, you should be able to run the phpstorm command from anywhere in the shell.