To install packages:
Note: to see where package configuration files are stored, go to Preferences > Browse Packages…
To uninstall packages, go to Command Palette > search for “Remove Package” > Enter > select the package you want to remove
Note: a lot of these packages have functionality that can be added to key bindings to improve their usability. See the Key Bindings page for more.
Allows you to create a terminal (a command-line interface) in the Sublime Text editor.
To open a terminal in its own panel:
To open a terminal as a tab:
To create a key binding that opens a terminal pointing to the same folder that the active file is in:
Open “Key Bindings”
• macOS: Sublime Text > Preferences > Key Bindings
• Windows & Ubuntu: Preferences > Key Bindings
Two files will open up: the default key bindings on the left-hand side and the user’s key bindings on the right-hand side. Confusingly, both of these files will be called “Default” ( even the User key bindings file):
• Linux: Default (Linux).sublime-keymap
• macOS: Default (OSX).sublime-keymap
• Windows: Default (Windows).sublime-keymap
Add the following in the User key bindings file (on the right-hand side) anywhere between the starting and ending square brackets:
/* Terminus */
{ "keys": ["shift+alt+t"], "command": "terminus_open", "args": {"cwd": "${file_path:${folder}}"} },The above line should end with a comma if and only if other custom key bindings follow it in the file. If it is the last (or only) custom key binding, omit the comma.
Save and close. The keyboard shortcut Shift+Alt+T should now work.
Note: by default, Terminus will create terminals that run Z Shell (zsh) on macOS and Bash on Ubuntu. These are the default shells for terminals on those OSs anyway so this shouldn’t be unexpected. However, these shells will be created in both interactive and login modes* which, while normal for macOS terminals, is not typical for Ubuntu terminals (these are usually created in interactive mode but not in login mode). This changes which startup files are read:
Ubuntu: the usual startup file is ~/.bashrc but Terminus terminals use ~/.bash_profile (only if these files exist - they don’t have to). One workaround is to just make the contents of both of these files identical (and to create one or both of them if they don’t exist). Another solution is to change the shell_configs for Bash in Terminus’s settings (Preferences > Package Settings > Terminus > Settings) to bash -i so terminals get created in interactive mode only (not in login mode).
macOS: it seems as if Terminus runs the path_helper utility twice (instead of once) when creating a terminal. When this is run it adds the paths in the /etc/paths file and in the /etc/paths.d folder’s files to the PATH variable. If these paths and/or other paths already exist in the PATH variable it won’t add duplicate paths but it will reorder them so that its paths appear first. Then, when the other start up files are run (~/.zprofile, /etc/zshrc and ~/.zshrc) they might prepend other paths to the PATH variable again, resulting in them appearing at both the start and the end of PATH. The easiest fix is to add the following to the end of ~/.zshrc (the last startup file to be run) which removes duplicate paths from PATH:
# Remove duplicates from PATH (the -U flag makes it *U*nique)
typeset -U PATH*The exact commands that Terminus runs in the background are zsh -i -l on macOS and bash -i -l on Ubuntu, although you can change this in Preferences > Package Settings > Terminus > Settings.
Allows you to build LaTeX files in the Sublime Text Build System (LaTeX must be installed on your computer for this to work):
For more info (eg about adding a dedicated key binding and/or creating a build command to help troubleshoot if the default build system doesn’t work) see the LaTeX page.
See the word count in a LaTeX file.
The one drawback is that this package does not display the live word count in the status bar. However, the WordCount package does, so install both.
See the live word count in the status bar.
Make JSON files more readable.
This command used to have a key binding assigned to it automatically but this is no longer the case. It can be added manually, however, as follows:
Open “Key Bindings”
• macOS: Sublime Text > Preferences > Key Bindings
• Windows & Ubuntu: Preferences > Key Bindings
Two files will open up: the default key bindings on the left-hand side and the user’s key bindings on the right-hand side. Confusingly, both of these files will be called “Default” ( even the User key bindings file):
• Linux: Default (Linux).sublime-keymap
• macOS: Default (OSX).sublime-keymap
• Windows: Default (Windows).sublime-keymap
Add the following in the User key bindings file (on the right-hand side) anywhere between the starting and ending square brackets:
/* Pretty JSON */
{ "keys": ["ctrl+alt+j"], "command": "pretty_json" },The above line should end with a comma if and only if other custom key bindings follow it in the file. If it is the last (or only) custom key binding, omit the comma.
Save and close. The keyboard shortcut Ctrl+Alt+T should now work.
A general Markdown plugin. See more about using Markdown in Sublime Text here.
Note: this package introduces a key binding conflict as it overwrites Ctrl+1/2/3. This isn’t an issue if you don’t use those bindings but if you do then create a user key binding to fix it.
To change the colour scheme of Markdown text windows, have the window with the undesirable colour scheme active and go to Preferences then “Settings - Syntax Specific”. Add the following in the Markdown file (on the right-hand side):
{
"extensions":
[
"md"
],
"color_scheme": "Packages/Color Scheme - Default/Monokai.tmTheme",
"save_on_focus_lost": true,
"line_numbers": true,
"translate_tabs_to_spaces": false
}If it starts to think that .txt files are Markdown files, open a .txt file (ie have that window active) and go: View > Syntax > Open all with current extension as… > select your syntax choice.
View rendered Markdown in your browser. You can create a user key binding to immediately open the current Markdown file as a rendered HTML page in your web browser.
Automatically refresh a webpage. This is useful to use in conjunction with MarkdownPreview as you can configure it to update your rendered text every time you save. This allows you to work in Markdown in one window and see your rendered output in another.
Open the package settings
• macOS: Menu bar > Sublime Text > Preferences > Package Settings > LiveReload > Settings - Default
• Ubuntu: Menu bar > Preferences > Package Settings > LiveReload > Settings - Default
Paste in the following:
{
"enabled_plugins": [
"SimpleReloadPlugin",
"SimpleRefresh"
]
}In your browser, install the “LiveReload” extension and enable it
• In Chrome, you also need to go to chrome://extensions/ then the “Details” page for LiveReload and enable “Allow access to file URLs”
Easily align columns in Markdown tables. The default key binding is:
Render code with (and get syntax highlighting for) R Markdown. For more info, see the R and R Markdown pages.
You need to have R Markdown installed on your computer for this package to work:
Run the following in R (either in the RStudio console or in R in the terminal):
install.packages('rmarkdown', repos='http://cran.us.r-project.org')If you want to render Python scripts with R Markdown you also need to have the “reticulate” package installed:
install.packages('reticulate', repos='http://cran.us.r-project.org')If you are on macOS you also need to install Xcode, htmltools and Pandoc (if you are on Ubuntu you also need to have the latter two but they might already be installed):
Xcode: you can download this from the App Store or from the Apple Developer site
htmltools: install this as with any other R package:
install.packages('htmltools', repos='http://cran.us.r-project.org')Pandoc: download from its website
This package - the Language Server Protocol - needs to be installed for the rendering of R Markdown to work.
Lint your code (check it for stylistic and formatting errors).
SublimeLinter is a linter framework - the linters themselves are not included and must be installed separately (both on your computer and in Sublime Text). As far as I can tell there’s no harm in installing more linters rather than fewer.
For Python:
Install the linters on your computer through pip:
# Replace "python3.12" with your version of Python
$ python3.12 -m pip install flake8
$ python3.12 -m pip install pycodestyle
$ python3.12 -m pip install pydocstyle
$ python3.12 -m pip install bandit
$ python3.12 -m pip install pyflakesInstall the linters in Sublime Text through Package Control:
For R:
Install the lintr package in R:
install.packages("lintr", repos = "http://cran.us.r-project.org")Install the SublimeLinter-contrib-lintr package in Sublime Text via the instructions in the next section
To see the results of the linting every time you save:
"show_panel_on_save": "view" to the user settings (on the right-hand-side)This is needed to get the R linter (lintr) working.
This package is not always available in Package Control so you can download it manually from here. Unzip it and move the folder into your packages folder (find where this is by opening Preferences > Browse Packages…).
Syntax highlighting for .ini files (initialisation/configuration files).
Create TODO lists. Comes with a short tutorial: Preferences > Package Settings > PlainTasks > Tutorial.
Preview reStructuredText (RST) in a web browser.
SublimeREPL
Enables code to be run in a separate tab in the editor (as opposed to in a panel at the bottom, which is what the default Sublime Text Build System does). It also enables you to create a Bash/Zsh terminal as a tab in the editor (via Tools > SublimeREPL > Shell) but this opens a ‘Sublime Text version’ of the terminal, not the actual terminal. This means, for example, that the PATH variable is different.
This package is neat but it doesn’t add to what Sublime Text can already do. Rather use the Terminus package to create terminals in the editor.
ElasticTabstops
Allows spacing that is created by using Tab to be more intuitive.
Chain of Command
Execute two commands at once.
sublimehighlight
Enables the ability to copy text whilst retaining the syntax highlighting.
MarkdownLivePreview
Use the MarkdownPreview + LiveReload functionality instead.
AutomaticFullscreen
It got annoying.
SummitLinter
A different attempt at integrating linting.
SublimeLinter Inline Errors
This linter does not work well, rather use SublimeLinter.
Behave Toolkit
Integration with Behave.
Jira
Integration with Jira.
PackageResourceViewer
View package resources.
Non Text Files
Open PDFs (and other binary files) in external applications, not in Sublime Text.
Python Flake8 Lint
Additional linting for Python.
Python PEP8 Autoformat
Interactively reformat Python code according to PEP8.
Python Open Module (New)
Opens the Python module file based on the Python import path.
FindKeyConflicts
Check to see if you have conflicting key bindings.