README.md

osx-tag

This is a module to operate tags on OSX Mavericks. You can get/set/add/remove tags with simple API methods. Works only on Mac OSX 10.9.x.

Quick Start

Install osx-tag with npm:

$ npm install osx-tag

Simple example:

var tag = require('osx-tag');
var path = 'foo.txt';

tag.getTags(path, function(err, tags) {
    if (err) throw err;
    console.log(tags);
    tag.addTags(path, ['Important', 'Photo'], function(err) {
        if (err) throw err;
    }); 
});

API

• All methods works asynchronously.
• All arguments are required and cannot be omitted.

getTags(path, callback)

• path - Path of the file/directory to retrieve tags.
• callback - This callback function gets two arguments (err, tags) where tags is an array of tag names.

setTags(path, tags, callback)

• path - Path of the file/directory to set tags.
• tags - Array of tag names to set. File/directory's tags are overwritten with these.
• callback - This callback gets one argument (err).

addTags(path, tags, callback)

• path - Path of the file/directory to add tags.
• tags - Array of tag names to add.
• callback - This callback gets one argument (err).

removeTags(path, tags, callback)

• path - Path of the file/directory to remove tags.
• tags - Array of tag names to remove.
• callback - This callback gets one argument (err).