bookmarks.yazi

A Yazi plugin that adds the basic functionality of vi-like marks.

YaziBookmarks.mp4

Requirements

• Yazi v0.3.0+

Features

• Create/delete bookmarks
• Custom Notifications
• '' to go back to the previous folder
• Bookmarks persistence

Installation

ya pack -a dedukun/bookmarks

Configuration

Add this to your keymap.toml:

[[manager.prepend_keymap]]
on = [ "m" ]
run = "plugin bookmarks --args=save"
desc = "Save current position as a bookmark"

[[manager.prepend_keymap]]
on = [ "'" ]
run = "plugin bookmarks --args=jump"
desc = "Jump to a bookmark"

[[manager.prepend_keymap]]
on = [ "b", "d" ]
run = "plugin bookmarks --args=delete"
desc = "Delete a bookmark"

[[manager.prepend_keymap]]
on = [ "b", "D" ]
run = "plugin bookmarks --args=delete_all"
desc = "Delete all bookmarks"

---

Additionally there are configurations that can be done using the plugin's setup function in Yazi's init.lua, i.e. ~/.config/yazi/init.lua. The following are the default configurations:

-- ~/.config/yazi/init.lua
require("bookmarks"):setup({
	save_last_directory = false, -- DEPRECATED - will be removed in the future. Use `last_directory`
	last_directory = { enable = false, persist = false },
	persist = "none",
	desc_format = "full",
	file_pick_mode = "hover",
	notify = {
		enable = false,
		timeout = 1,
		message = {
			new = "New bookmark '<key>' -> '<folder>'",
			delete = "Deleted bookmark in '<key>'",
			delete_all = "Deleted all bookmarks",
		},
	},
})

save_last_directory

When enabled, a new bookmark is automatically created in ' which allows the user to jump back to the last directory.

NOTE: This option is DEPRECATED and will be removed in the future in favor of last_directory.

last_directory

When enabled, a new bookmark is automatically created in ' which allows the user to jump back to the last directory.

There's also the option to enable persistence to this automatic bookmark.

persist

When enabled the bookmarks will persist, i.e. if you close and reopen Yazi they will still be present.

There are three possible values for this option:

Value	Description
none	The default value, i.e., no persistance
all	All the bookmarks are saved in persistent memory
vim	This mode emulates the vim global marks, i.e., only the bookmarks in upper case (A-Z) are saved to persistent memory

desc_format

The format for the bookmark description.

There are two possible values for this option:

Value	Description
full	The default, it shows the full path of the bookmark, i.e., the parent folder + the hovered file
parent	Only shows the parent folder of the bookmark

file_pick_mode

The mode for choosing which directory to bookmark.

There are two possible values for this option:

Value	Description
hover	The default, it uses the path of the hovered file for new bookmarks
parent	Uses the path of the parent folder for new bookmarks

notify

When enabled, notifications will be shown when the user creates a new bookmark and deletes one or all saved bookmarks.

By default the notification has a 1 second timeout that can be changed with notify.timeout.

Furthermore, you can customize the notification messages with notify.message. For the new and delete messages, the <key> and <folder> keywords can be used, which will be replaced by the respective new/deleted bookmark's associated key and folder.