Introducing SublimeTask (GTD)

We already have Vim-Task, now we need one task plugin for Sublime Text 2.

As always, I’m a fan of the mac default font monaco, unfortunately it doesn’t support bold and italic:

If you use font (e.g. Consolas) which support bold and italic and your current color scheme also support these highlighting, you can config the “scope” to display whatever style you want (see Customization section below).

[Code Repository]

I assume you have git installed, if not, you can download the latest source from Github Downloads then copy the whole directory into the Packages directory.

The location of the “Packages” packages directory depends on the OS you’re using, below is a possible location that you may find your Packages directory:

  • OS X:
    ~/Library/Application Support/Sublime Text 2/Packages
  • Linux:
    ~/.Sublime Text 2/Packages
  • Windows:
    %APPDATA%/Sublime Text 2/Packages

We will take OS X for example for all the instructions below:

$ cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/
$ git clone

TODO: add this Package to sublime_package_control, so later we can install it directly in editor via package control.
UPDATE: This package has already been accepted by sublime_package_control, now you can install it directly in the editor, the package name there is just called “Task”.

[Shortcut Key & Key Binding]
By default, I mapped Command+Ctr+Enter (OS X) and Ctrl+Shift+Enter (Windows, Linux) for toggling the task status, you can simply remap to what’s the most comfortable for you in your Default User keymap filei.


{ "keys": ["super+ctrl+enter"], "command": "task"}

Linux, Windows:

{ "keys": ["ctrl+shift+enter"], "command": "task"}

To change the task display color, you need to edit a file called Task.tmLanguage bundled together with this SublimeTask package.

$ subl ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/SublimeTask/Task.tmLanguage

(you may need to enable sublime command line invocation to execute above command)

  <string>Completed Tasks</string>

As you can see above, I use “string” scope for the Completed Tasks by default, which will be mapped to green in my color scheme file. If it doesn’t look good in your color scheme, you can simply customize it by changing “string” to something appropriate to your color scheme.

You can find the scope name in your color scheme file.

[File Format & Syntax]
The Task grammar and commands by default apply to file todo.txt and files with extension .task, .tasks, .todo and .todolists. You can also customize this by editing SublimeTask/Task.tmLanguage:


All the formats and syntax is similar, quoted below for your references:

Headers end with a colon (“:”).
Pending (uncompleted) tasks start with a hyphen (“-“). Completed tasks start with a checkmark (“✓”).
Headers and tasks can be indented for grouping/hierarchy, as seen in the screenshot above.

[Bug & Feedback]
Please report bugs and issues to github:, any feedback and suggestion is welcome.

  1. Default (OSX).sublime-keymap, Default (Windows).sublime-keymap, Default (Linux).sublime-keymap []


Related posts:

11 Comments on "Introducing SublimeTask (GTD)"

  1. Tane Piper United Kingdom Google Chrome Mac OS says:

    It seems one of the most popular plugins to create for ST2 is a Todo/Task manager (including mine, we now have 3!) – but competition is a healthy thing

    • Samson Wu China Google Chrome Mac OS says:

      Interesting I’m not aware of that, thanks for the heads up.
      I don’t mean to compete, but yeah, that’s a healthy thing :). And it’s always a good idea for the users to have more options.

  2. Tomo Czech Republic Opera Windows says:

    Hello Samson,
    can i have a question? What colour scheme do you use in the screenshot of your ST2? Thanks in advance.

  3. Sebastian United States Google Chrome Windows says:

    Samson, in your screenshot, what are you using for tab indentation?

  4. cooldoger United States Google Chrome Windows says:

    Hi Samson, zhe huo shi Vim ma?

Trackbacks for this post

  1. Highlight URL in SublimeTask | Samson's Weblog United States WordPress Unknow Os
  2. Multiple line support in SublimeTask | Samson's Weblog United States WordPress Unknow Os
  3. SublimeTask for both ST2 and ST3 | Samson's Weblog United States WordPress Unknow Os

Got something to say? Go for it!