Command-line interface
Use PhpStorm features from the command line: open files and projects, view diffs, merge files, apply code style, formatting, and inspect the source code.
Launcher for a standalone instance
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:
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
:
To update it system-wide for all users, run setx /M
instead of setx
.
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:
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:
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:
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:
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.
Shell scripts generated by the Toolbox App
If you are using the Toolbox App to install and manage JetBrains products, it can create shell scripts for launching your IDEs from the command line.
Generate shell scripts
Open the Toolbox App and click
in the top right corner.
In the Toolbox App Settings, enable Generate shell scripts.
If necessary, change the shell scripts location.
![Set scripts path in Toolbox Set scripts path in Toolbox](https://resources.jetbrains.com/help/img/idea/2022.1/ps_toolbox_set_scripts_path.png)
If you have several versions of the same IDE, the Toolbox App generates a shell script for each version with a unique name. You can change the name of the shell script for an IDE instance in the settings for this specific instance.
Change the name of the shell script
Open the Toolbox App.
Click
next to the relevant IDE instance and select Settings.
At the bottom, change the Shell script name field.
![Generation in Toolbox Generation in Toolbox](https://resources.jetbrains.com/help/img/idea/2022.1/ps_toolbox_generated_script_name.png)
By default, the Toolbox App puts shell scripts in a directory from the system PATH
environment variable, so you can run the name of the script as a command to launch PhpStorm from any working directory.
Command-line arguments
The launcher script accepts commands, options, and other arguments to modify its behavior:
Argument | Description |
---|---|
No argument | Launch PhpStorm. |
Path to file or directory | Open the file or directory specified as the argument. For more information, see Open files from the command line. |
Commands | |
| Open the diff viewer to see differences between two specified files. For more information, see Compare files from the command line. |
| Open the Merge dialog to merge the specified files. For more information, see Merge files from the command line. |
| Apply code style formatting to the specified files. For more information, seeFormat files from the command line. |
| Perform code inspection on the specified project. For more information, see Run code inspections from the command line. |
Options | |
| Do not show the splash screen when loading PhpStorm. |
| Do not reopen projects and show the welcome screen. This can help if a project that was open crashes PhpStorm. |
| Do not load manually installed plugins. This can help if a plugin that you installed crashes PhpStorm. You will be able to start the IDE and either disable or uninstall the problematic plugin. |
| Wait for the files to be closed before returning to the command prompt. |