:anchor: anchor.nvim :anchor:

Installation • Usage • Configuration • Commands

Harpoon for Directories! Anchor lets you bookmark directories instead of files, making it easy to jump between related repositories, notes, dotfiles, and more using your favorite fuzzy finder.

Installation

vim.pack.add({ src = 'https://github.com/zachyarbrough/anchor.nvim' })

require('lazy').setup({
  {
      'zachyarbrough/anchor.nvim',
      opts = {},
  }
})

require('packer').startup(function()
  use({
    'zachyarbrough/anchor.nvim',
    config = function()
      require('anchor').setup()
    end,
  })
end)

require('paq')({
  { 'zachyarbrough/anchor.nvim' },
})

Plug 'zachyarbrough/anchor.nvim'

Usage

The following keymaps provide a good starting point. Feel free to customize them to fit your workflow.

local function anchor()
    return require('anchor')
end

vim.keymap.set('n', '<leader>aa', function() anchor().add() end, { desc = 'Add a directory to the anchor list' })
vim.keymap.set('n', '<leader>ad', function() anchor().delete() end, { desc = 'Delete a directory from the anchor list' })
vim.keymap.set('n', '<leader>al', function() anchor().toggle_list() end, { desc = 'Open anchor list in a floating buffer' })
vim.keymap.set('n', '<leader>a0', function() anchor().return_to_cwd() end, { desc = 'Return back to cwd' })

vim.keymap.set('n', '<leader>a1', function() anchor().open(1) end, { desc = 'Open fuzzy finder for anchor 1' })
...
vim.keymap.set('n', '<leader>a5', function() anchor().open(5) end, { desc = 'Open fuzzy finder for anchor 5' })

If the selected picker supports grepping files, you can live grep the anchored directory with the below keymaps. (Currently supports fzf-lua, telescope, mini.picks, and snacks.picker)

vim.keymap.set('n', '<leader>ag1', function() anchor().grep(1) end, { desc = 'Open fuzzy finder with live grep for anchor 1' })
...
vim.keymap.set('n', '<leader>ag5', function() anchor().grep(5) end, { desc = 'Open fuzzy finder with live grep for anchor 5' })

Configuration

require('anchor').setup({
    -- UI options for anchor list buffer
    winopts = {
    	width = 80,
    	height = 15,
    	border = 'rounded',
    	title = 'Anchor',
	    numbers = 'absolute' -- 'absolute', 'relative', 'none'
    },
    -- UI options for fuzzy finder (currently only supported by fzf-lua and telescope)
    picker_opts = {
        grep = {}, -- UI Options for live grep
        files = {} -- UI Options for file search
    },
    picker = 'auto',        -- 'fzf-lua', 'telescope', 'default' (netrw), 'oil', 'mini', 'snack' or 'auto'
    relative_paths = true, -- Display relative paths in the anchor list

    excluded_dirs = { '.git', '.cache' }, -- Directories to exclude in fuzzy finder search
    extended_excluded_dirs = { },         -- User specific directories to exclude in fuzzy finder search
})

Commands