telescope-orgmode.nvim

Provides integration for orgmode and org-roam.nvim with telescope.nvim.

Demo

Jump to to any heading in org_agenda_files with :Telescope orgmode search_headings

Refile heading from capture or current file under destination with :Telescope orgmode refile_heading

Installation

With lazyvim

  {
    "nvim-orgmode/telescope-orgmode.nvim",
    event = "VeryLazy",
    dependencies = {
      "nvim-orgmode/orgmode",
      "nvim-telescope/telescope.nvim",
    },
    config = function()
      require("telescope").load_extension("orgmode")

      vim.keymap.set("n", "<leader>r", require("telescope").extensions.orgmode.refile_heading)
      vim.keymap.set("n", "<leader>fh", require("telescope").extensions.orgmode.search_headings)
      vim.keymap.set("n", "<leader>li", require("telescope").extensions.orgmode.insert_link)
    end,
  }

Without lazyvim

You can setup the extension by doing:

require('telescope').load_extension('orgmode')

To replace the default refile prompt:

vim.api.nvim_create_autocmd('FileType', {
  pattern = 'org',
  group = vim.api.nvim_create_augroup('orgmode_telescope_nvim', { clear = true }),
  callback = function()
    vim.keymap.set('n', '<leader>or', require('telescope').extensions.orgmode.refile_heading)
  end,
})

Available commands

:Telescope orgmode search_headings
:Telescope orgmode refile_heading
:Telescope orgmode insert_link

Available functions

require('telescope').extensions.orgmode.search_headings
require('telescope').extensions.orgmode.refile_heading
require('telescope').extensions.orgmode.insert_link

Toggle between headline and org file search

By pressing <C-Space> the picker state can be toggled between two modes. Every mode is available in every function.

Search headlines

This is the first and default mode. It shows all the headlines, initially sorted by most recently changed org file. The level of headlines can be configured.

Search org files

This is the second mode, which shows only org files. If the org file has a title, it is shown (and used for filtering) instead of the filename. This is particular useful in connection with org-roam.nvim to fuzzy search for roam nodes.

Configuration

You can limit the maximum headline level included in the search. nil means unlimited level, 0 means only search for whole org files. The later is equivalent with org file mode

To enable the configuration for all commands, you pass the option to the setup function of telescope:

require('telescope').setup({
    extensions = {
        orgmode = {
            max_depth = 3
        }
    }
})

For a particular command you can pass it directly in your key mapping to the function:

require('telescope').extension.orgmode.search_headings({ max_depth = 3 })

You can also create a key mapping, that allows you to search directly for org files:

vim.set.keymap(
  "n",
  "<Leader>off", 
  function()
    require('telescope').extension.orgmode.search_headings({ mode = "orgfiles" })
  end,
  { desc = "Find org files"}
)