PhpStorm
 
2023.2
Shortcuts: Windows
Get PhpStorm
You are viewing the documentation for an earlier version of PhpStorm.
  1. Version control
  2. Mercurial

Mercurial

Last modified: 23 August 2023

Mercurial support

  • When Mercurial integration with PhpStorm is enabled, the Mercurial option appears in the VCS menu, and in the context menus of the editor and Project tool window.

  • The files in the folders under the Mercurial control are highlighted according to their status. See File status highlights for file status highlighting conventions.

  • Modifications results are shown in the Commit tool window Alt00.

  • When using Mercurial integration, it is helpful to open the Console tab of the Mercurial tool window Alt09, which displays the following data:

    • All commands generated based on the settings you specify through the PhpStorm user interface.

    • Information messages concerning the results of executing generated Mercurial commands.

    • Error messages.

Set up Mercurial

Make sure that Mercurial is installed on your computer.

Configure Mercurial executable

  1. Press CtrlAlt0S to open the IDE settings and then select Version Control | Mercurial.

  2. In the Path to Mercurial executable field, specify the path to hg executable.

    If you followed the standard installation procedure, the default location is /Applications/TortoiseHg.app/Contents/MacOS/hg or /usr/local/bin for Linux and macOS and /Program Files/TortoiseHG for Windows.

    It is recommended that you add the path to the Mercurial executable file to the PATH variable. In this case, you can specify only the executable name, the full path to the executable location is not required.

  3. Click Test to make sure the path is specified correctly. Click Apply to save the changes and close the dialog.

Enable Mercurial integration for your project

  1. Press Alt0` to open the VCS Operations Popup and select Enable Version Control Integration.

    Alternatively, go to VCS | Enable Version Control Integration.

  2. In the Enable Version Control Integration dialog that opens, select Mercurial.

  3. Click OK to apply the changes.

tip

If you want to use a remote repository, create a Mercurial hosting account first. You can access the remote repository through a pair of ssh keys or apply the username/password and keyboard interactive authentication methods supported by the Mercurial integration.

See also

Procedures

Reference