Sublimerge Pro (2.x) documentation

Quick Start


Sublime Text 2 or 3

Sublimerge is a plugin, not a standalone application. Thus it requires any version of Sublime Text 2 or 3 to work.

Your operating system does not matter - Sublimerge works on every platform supported by Sublime Text: OS X, Windows and Linux.

VCS systems (optional)

The following Version Control Systems are supported, however their existence is not required:

  • Git
  • Subversion (SVN)
  • Mercurial (Hg)

Learn about built-in commands for VCS systems: Tutorial/Comparing versioned files.

Learn how to define your own custom commands: Custom Comparisons.

Learn how to run Sublimerge from command line: VCS integration.


With Package Control

Recommended. Package Control does not require your attention to keep Sublimerge up to date. All updates will be installed automatically as soon as they are released.

  1. Install the Package Control (if you haven't already)
  2. Open Command Palette ([ctrl]+[shift]+[p] on Windows and Linux, [cmd]+[shift]+[p] on Mac)
  3. Choose Package Control: Install Package
  4. Search for Sublimerge Pro and hit [Enter]
  5. Restart Sublime Text to complete the installation
Make sure you use the final version of Package Control. Alpha versions may not install Sublimerge correctly and it will not work resulting in loading errors.

Manually from Package

Not recommended. You will need to stay tuned with Sublimerge updates and install them manually. You can follow @sublimerge on Twitter to get notifications about new releases.

  • Sublime Text 2
    1. Download ZIP: Sublimerge
    2. Go to Preferences > Browse Packages...
    3. Create directory Sublimerge Pro (name is important!)
    4. Extract the ZIP into that directory
    5. Restart Sublime Text
  • Sublime Text 3
    1. Download Package: Sublimerge Pro.sublime-package
    2. Go to Preferences > Browse Packages...
    3. Go one folder up
    4. Go to Installed Packages
    5. Copy the package to that directory
    6. Restart Sublime Text
Also use this installation method if you don't use final version of Package Control. Please visit Support page for more details.

Installing License

Without a License, Sublimerge runs in evaluation mode. You will have 90 days to evaluate Sublimerge without any functionality limitations. Later you will need to purchase a License. Evaluation copy will display a cyclic reminder message.

Once License is purchased, take the following steps to install it:

  1. Go to Preferences > Package Settings > Sublimerge
  2. Select Enter License
  3. Paste your license key in the textbox appearing in the bottom
  4. Press [Enter]

When License Key is installed successfuly, confirmation message will appear. Otherwise, if you get error message, please check if you entered License Key correctly without any mistakes.

I serve cookies to improve your experience on this website. If you continue without changing your browser settings, I will assume that you accept the cookies. You can change your browser settings at any time.