ctrl+shift+p filters: :st2 :st3 :win :osx :linux


The default settings can be viewed by accessing the Preferences > Package Settings > Package Control > Settings – Default menu. To ensure settings are not lost when the package is upgraded, make sure all edits are saved to Settings – User.

If set to true, will print HTTP headers and other debug information to the Sublime Text console.
Default false
If installs, upgrades and removals should be logged to the reporting URL. This data will be used to power the community package listing and will be displayed in aggregate only. No user-identifiable information is sent, just the: package name, operation, package version, package control version, sublime version and sublime platform.
Default yes
Where the usage information should be sent to.
Default "https://packagecontrol.io/submit"
A list of packages that have been installed. Package Control will automatically install any packages in this list that are not currently installed, allowing this to be used for sharing package lists with other users. This setting is only tracked in Settings – User.
Default []
A list of URLs that each contain a JSON file with a list of repositories. The repositories from these channels are placed in order after the repositories from the repositories setting.
Default ["https://packagecontrol.io/channel_v3.json"]
A list of URLs that contain a packages JSON file. These repositories are placed in order before repositories from the repository_channels setting.
Default []
A list of packages to install pre-release versions for. Versions under 1.0.0 are not considered pre-release, only those using the SemVer -prerelease suffixes will be ignored if the package is not in this list.
Default []
This helps solve naming issues where a repository it not named the same as the package should be. This is primarily only useful for GitHub and BitBucket repositories. This mapping will override the mapping that is retrieved from the repository channels.
Default {}
If packages installed via Package Control should be checked for updates when Sublime Text starts. Updates will be automatically installed.
Default true
The number of hours to wait before trying to auto upgrade packages again.
Default 6
Packages to exclude from the auto upgrade functionality.
Default []
If set to false, will not automatically install packages from the installed_packages setting that are not present on the current machine. This is really only useful if you don’t want Sublime Text to connect to the internet without explicitly requesting it. In that case you’ll want to set auto_upgrade to false also.
Default true
The HTTP timeout (in seconds) to use when downloading channels, repositories and packages.
Default 30
The number of seconds to cache channel and repository metadata for.
Default 300
If HTTP request responses should be cached.
Default true
Number of seconds to cache HTTP responses for.
Default 604800
The proxy to use for HTTP requests. Should be in the form domainname:port or ip:port.
Default ""
The proxy to use for HTTPS requests. If http_proxy is set and this settings is not, the value from http_proxy will be used. If set to false, then http_proxy will not be inherited. Should be in the form domainname:port or ip:port.
Default ""
The username to use for proxy authentication.
Default ""
The password to use for proxy authentication.
Default ""
The user agent used by the various downloaders.
Default "Package Control v{version.number}"
Custom path(s) to git binary for when it can't be automatically found on the system and a package includes a .git metadata directory. Supports more than one path to allow users to sync settings across operating systems.
Default []
The parameters passed to git to update a package. The remote and branch will be automatically determined.
Default ["pull", "--ff", "--commit"]
Custom path(s) to hg binary for when it can't be automatically found on the system and a package includes a .hg metadata directory. Supports more than one path to allow users to sync settings across operating systems.
Default []
The parameters to pass to hg to update a package. Will always pull from the URL named default.
Default ["pull", "--update"]
If git and hg repositories should be ignored when trying to update packages.
Default false

The downloader backends that should be used for HTTP(S) requests, split by operating system to allow for configuration to be shared.

Valid options include: "urllib", "curl", "wget", (Windows-only) "wininet".

This setting allows Windows users to bypass wininet and use urllib instead if they machine or network presents trouble to wininet. Some OS X and Linux users have also reported better luck with certain proxies using curl or wget instead of urllib.

The "curl" and "wget" options require the command line curl or wget program installed and present in the PATH.

    "windows": ["wininet"],
    "osx": ["urllib"],
    "linux": ["urllib", "curl", "wget"]
A list of folders to ignore when creating a .sublime-package file.
Default [".hg", ".git", ".svn", "_darcs", "CVS"]
A list of file glob patterns to ignore when creating a .sublime-package file by the Create Package command.
Default [".hgignore", ".gitignore", ".bzrignore", "*.pyc", "*.sublime-project", "*.sublime-workspace", "*.tmTheme.cache"]
A list of file glob patterns to include when creating a .sublime-package file by the Create Package command. This overrides files_to_ignore.
Default []
The folder to copy a newly created package to. Default to the user’s Desktop if blank. Setting this destination to the Installed Packages directory will cause your source code changes to be overwritten when Sublime Text restarts!
Default ""

A way to create different packaging profiles for different types of package releases, such as for different platforms or binary-only releases.

The key of the object will be the profile name and a list of them will be presenting when running the "Create Package File" command. The profile "Default" will use the top-level version on the following settings:

  • "dirs_to_ignore"
  • "files_to_ignore"
  • "files_to_include"
  • "package_destination"

If a profile does not include one of those three setting, it will fall back to the top-level settings.

    "Binaries Only": {
        // Exclude all .py files, but consequently include all .pyc files
        "files_to_ignore": [
            "*.py", ".hgignore", ".gitignore", ".bzrignore",
            "*.sublime-project", "*.sublime-workspace", "*.tmTheme.cache"

        // Include __init__.py so Sublime Text will load the package
        "files_to_include": [
Enable the ability to run the tests - this is only for development.
Default false