Installation

SublimeLinter itself is only a framework for linters. The linters are distributed as independent Sublime Text 3 plugins.

SublimeLinter (and the linter plugins) can be installed via Package Control or from source. I strongly recommend that you use Package Control! Not only does it ease installation, but more importantly it automatically updates the plugins it installs, which ensures you will get the latest features and bug fixes.

Upgrading from previous versions

If you are upgrading to SublimeLinter 3 from a previous version (including an ST3 branch), please be aware that SublimeLinter 3 is a complete rewrite and is not a drop-in replacement. The basic functionality is the same, but there are key differences:

  • Linters are not included, you must install them — and the linter binaries they depend on — separately. Linters can be found in Package Control with the name “SublimeLinter-<linter>”, for example “SublimeLinter-jshint”.
  • Settings do not work in the same way.
  • You no longer need to use path settings voodoo to find linter executables. Anything in your system PATH is found automatically.
  • Most settings can be configured via menus and the Command Palette, which you are encouraged to do.
  • There are dozens of new features.

Warning

SublimeLinter 3 is not a drop-in replacement for earlier versions. If you are coming from an earlier version of SublimeLinter and don’t read the documentation, you will get confused and frustrated. Read the docs.

Installing via Package Control

To install SublimeLinter via Package Control, follow these steps:

  1. Open the Command Palette (cmd+shift+p on Mac OS X, ctrl+shift+p on Linux/Windows).
  2. Type install and select Package Control: Install Package from the Command Palette. There will be a pause of a few seconds while Package Control finds the available packages.
  3. When the list of available packages appears, type linter and select SublimeLinter. Note: The github repository name is “SublimeLinter3”, but the plugin name remains “SublimeLinter”.
  4. After a few seconds SublimeLinter will be installed and loaded. Depending on your setup, you may see some prompts from SublimeLinter. For more information on SublimeLinter’s startup actions, see Startup actions.
  5. You will see an install message. After reading the message, restart Sublime Text 3.

If you have a previous installation of SublimeLinter via Package Control, including “SublimeLinter Beta”, it should be updated correctly from the new version. If something goes wrong, use Package Control to remove SublimeLinter and then follow the steps above to install again.

Note

SublimeLinter 3 does not include linters, unlike earlier versions. You must install linter plugins separately. They can be found in Package Control with the name “SublimeLinter-<linter>”, for example “SublimeLinter-jshint”.

Installing from source

I very strongly discourage you from installing from source. There is no advantage to installing from source vs. using Package Control. In fact, there are several disadvantages, including no automatic updates, no update messages, etc.

If you insist on installing from source, please do not do so unless you are comfortable with the command line and know what you are doing. To install SublimeLinter from source, do the following:

  1. Quit Sublime Text.

  2. If you have a previous source installation at Packages/SublimeLinter, delete it.

  3. Type in a terminal:

    cd '/path/to/Sublime Text 3/Packages'
    git clone https://github.com/SublimeLinter/SublimeLinter3.git SublimeLinter
    
  4. Restart Sublime Text 3.

Please consider using Package Control instead!

Linter plugins

Regardless of how you install SublimeLinter, once it is installed you will want to install linters appropriate to the languages in which you will be coding.

Warning

Linter plugins are not part of SublimeLinter 3.

Linter plugins are separate Sublime Text 3 plugins that are hosted in separate repositories. There are a number of officially supported linter plugins in the SublimeLinter organization. There are third party linters available as well.

Again, I strongly recommend that you use Package Control to locate and install linter plugins. To install linter plugins in Package Control, do the following:

  1. Open the Command Palette (cmd+shift+p on Mac OS X, ctrl+shift+p on Linux/Windows).
  2. Type install and select Package Control: Install Package from the Command Palette. There will be a pause of a few seconds while Package Control finds the available packages.
  3. When the list of available packages appears, type sublimelinter-. You will see a list of plugins whose names begin with “SublimeLinter-”. Click on the plugin you wish to install.
  4. After a few seconds the plugin will be installed and loaded. You will then see an install message with instructions on what you should do to complete the installation.
  5. After reading the instructions, restart Sublime Text 3.

Warning

Most linter plugins require you to install a linter binary or library and configure your PATH so that SublimeLinter can find it. You must follow the linter plugin’s installation instructions to successfully use it.

If you have problems installing or configuring SublimeLinter, please do not open a ticket on github. First read the Troubleshooting guide. Then if necessary, report your problem on the SublimeLinter google group.

Note

Your first post to the SublimeLinter google group is moderated to allow us to filter out spam. Please do not post multiple times if your post does not appear immediately.

Read the docs!

An enormous amount of time and effort went into creating SublimeLinter and this documentation. Before you launch Sublime Text 3 with SublimeLinter installed, please take the time to read the Usage documentation to understand what happens when SublimeLinter loads and how it works. Otherwise you won’t get the most out of it!