PyCharm 5.0 Help

Using Mercurial Integration

With the Mercurial integration enabled, you can perform basic Mercurial operations from inside PyCharm.

In this section:


  • Mercurial is installed on your computer.
  • The location of the Mercurial executable file hg.exe is correctly specified on the Mercurial page of the Settings dialog box.

    If you followed the standard installation procedure, the default location is /opt/local/bin or /usr/local/bin for Linux and OS X 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. For more information about environment variables, see Path Variables.

  • Mercurial integration is enabled for the current project root or directory.

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.

Mercurial Support

  • When Mercurial integration with PyCharm is enabled, the Mercurial item appears on the VCS menu, and on the context menus of the Editor and Project views.
  • 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 Version Control tool window.
  • When using Mercurial integration, it is helpful to open the Version Control tool window. The Console tab displays the following data:
    • All commands generated based on the settings you specify through the PyCharm user interface.
    • Information messages concerning the results of executing generated Mercurial commands.
    • Error messages.

See Also

Last modified: 5 November 2015