Skip to content
An OM metadata package for Sublime Text
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
Default (OSX).sublime-keymap


Koan for Sublime Text 2 and 3

A package that sets and searches Mac OS X OpenMeta metadata for your Sublime Text 2 and 3 files. It can currently set and search tags and ratings. Note that this plugin is not compatible with other Unix-based systems, even if they support OpenMeta tagging.


Koan is once again available in Sublime Package Control! To download it from the database, mash ⌘+⇧+P on your keyboard, search for "Package Control: Install Package," and search the list of packages for "Koan."

You can also install Koan by downloading the repo's zip, renaming the folder you extract to Koan (rather than Koan-master), and copying it into your Sublime Text packages directory: ~/Library/Application Support/Sublime Text 3/Packages for ST3 users, ~/Library/Application Support/Sublime Text 2/Packages for ST2 users. Cloning the repository with git or Github's GUI is always an option.


Press ⌘+K, t to activate the input window. Enter a comma-separated list of tags. To search for tags within a project, press ⌘+K, f and enter a search query. A quick panel will be displayed with files in any opened folder tagged with your query. ⌘+K, r will allow you to set an OpenMeta rating, and ⌘+K, s will list files in the current project based on their ratings. ⌘+K, c will allow you to set the file's Finder label color. All of these are also accessible via the Command Palette; just pull it up and search for "Koan."

Previous versions included preliminary support for setting and searching Spotlight comments, but this was scrapped because the Finder was not pulling its metadata from the xattrs.


⌘+K, s is bound to the command list_koan_ratings, which takes an optional argument, "direction". By default, it's set to "low_to_high", which tells the package to order the ratings list from lowest to highest. Changing it to "high_to_low" will reverse this behavior.

Something went wrong with that request. Please try again.