zfm - Zsh Fuzzy Marks

zfm is a minimal command line bookmark manager for zsh built on top of fzf. It lets you bookmark files and directories in your system and rapidly access them.

It's intended to be a less intrusive alternative to z, autojump or fasd that doesn't pollute your prompt command or create bookmarks behind the scenes: you have full control over what gets bookmarked and when, like bookmarks on a web browser.

Installation

Install fzf

zfm is built on top of fzf so you must install that first. Follow the instructions here.

Install zfm

Oh My Zsh

1. Clone the repo in Oh My Zsh's plugin directory:

git clone https://github.com/pabloariasal/zfm ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zfm}

1. Activate the plugin in your .zshrc:

plugins=(zfm)

Antigen

Add this to your .zshrc:

antigen bundle pabloariasal/zfm

Manual (Git Clone)

1. Clone the repo

git clone https://github.com/pabloariasal/zfm ~/.zsh/zfm

1. Add the following to your .zshrc:

source ~/.zsh/zfm/zfm.zsh

Usage

Bookmark a directory or a file

$ zfm add ~/Downloads ~/Documents/wallpaper.png

List bookmarks

$ zfm list
/home/pablo/Downloads                [d]
/home/pablo/Documents/wallpaper.png  [f]

restrict to just files:

$ zfm list --files
/home/pablo/Documents/wallpaper.png  [f]

or directories:

$ zfm list --dirs
/home/pablo/Downloads  [d]

Select Bookmarks

Pressing ctrl+o will open an fzf fuzzy selection menu and insert your selection(s) into the current command line:

cd into a bookmarked directory

Pressing ctrl+p will open a selection menu with all your bookmarked directories and directly jump to the directory you have selected:

Alternatively, you can type f followed by a pattern to directly jump to the directory matching the pattern (like autojump):

$ f down
/home/pablo/Downloads$

If the pattern is ambiguous a selection menu will be opened with the possible options.

Use in custom scripts

For example, you can create an alias to open a bookmarked file with vim by adding this to your .zshrc

alias of='vim $(zfm select --files --multi)'

Typing of will open a selection menu with all bookmarked files and directly open the selection in vim.

The option --multi allows you to select multiple entries.

Edit Bookmarks

You can edit your bookmarks with:

zfm edit

This will open your current text editor (as defined by EDITOR) and let you manually edit, remove or reorder your bookmarks.

Commands

Options

Key Bindings

F.A.Q

Why not autojump, z, fasd and others?

Because explicit is better than implicit. I don't want every single directory I visit to be bookmarked, I know which directories I visit the most and which files I need rapid access to.

I don't like the default key bindings, can I change them?

Sure, you can unbind them by putting this on your zshrc:

bindkey -r '^P'
bindkey -r '^O'

Or change them to something else:

bindkey -r '^P'
bindkey -r '^O'
bindkey '^A' zfm-cd-to-bookmark
bindkey '^E' zfm-insert-bookmark

Tip: you can use Ctrl+v on your terminal window to display escape sequences of key bindings.

</article