SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
shellcheck is installed on your system.
shellcheck, follow the instructions on the shellcheck GitHub repository.
shellcheck can be installed with
apt-get on Debian sid,
brew on Mac OS X, or compiled from its Haskell sources (manually, or through
There is no Windows installer.
If you install it manually, make sure to use a version more recent than commit 376d407ea10b55 (2013-11-13 17:28:08, between version 0.2.0 and 0.3.0), where an easily parseable output was added.
shellcheck is installed, you must ensure it is in your system PATH so that SublimeLinter can find it. This may not be as straightforward as you think, so please read about how linter executables are located in the documentation.
In order for
shellcheck to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.
Once you have installed and configured
shellcheck, you can proceed to install the SublimeLinter-shellcheck plugin if it is not yet installed.
Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
To install via Package Control, do the following:
Within Sublime Text, bring up the Command Palette and type
install. Among the commands you should see
Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.
When the plugin list appears, type
shellcheck. Among the entries you should see
SublimeLinter-shellcheck. If that entry is not highlighted, use the keyboard or mouse to select it.
In the console, you should see a message stating
SublimeLinter: shellcheck activated: /usr/local/bin/shellcheck
In addition to the standard SublimeLinter settings, SublimeLinter-shellcheck provides its own settings. Those marked as “Inline Override” may also be used inline.
|exclude||A comma-delimited list of codes to exclude.||✓|
You can use a single string (ex:
"SC2034,SC2086"), or an array of strings if not inline (ex:
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- Be patient. ;-)
Please note that modications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbrevations unless they are very well known.
Thank you for helping out!