plugins/mactag.yazi/README.md

mactag.yazi

Bring macOS's awesome tagging feature to Yazi! The plugin it's only available for macOS just like the name says.

Authors: @AnirudhG07, and @sxyazi

Note that this plugin is still under development.

Installation

Install the plugin itself, and jdberry/tag used to tag files:

ya pack -a yazi-rs/plugins:mactag
brew update && brew install tag

Setup

Add the following to your ~/.config/yazi/init.lua:

require("mactag"):setup {
	-- You can change the colors of the tags here
	colors = {
		Red    = "#ee7b70",
		Orange = "#f5bd5c",
		Yellow = "#fbe764",
		Green  = "#91fc87",
		Blue   = "#5fa3f8",
		Purple = "#cb88f8",
		Gray   = "#b5b5b9",
	},
}

And register it as fetchers in your ~/.config/yazi/yazi.toml:

[[plugin.prepend_fetchers]]
id   = "mactag"
name = "*"
run  = "mactag"

[[plugin.prepend_fetchers]]
id   = "mactag"
name = "*/"
run  = "mactag"

Usage

This plugin also provides the functionality to add and remove tags. Add following keybindings to your ~/.config/yazi/keymap.toml to enable it:

[[manager.prepend_keymap]]
on   = [ "t", "r" ]
run  = 'plugin mactag --args="add Red"'
desc = "Tag selected files with red"

[[manager.prepend_keymap]]
on   = [ "t", "R" ]
run  = 'plugin mactag --args="remove Red"'
desc = "Remove red tag from selected files"

Red can be any tag name you like. To add/remove multiple tags at once, use a comma (,) to separate them, like Red,Yellow.