{"id":13761179,"url":"https://github.com/nvim-neorg/neorg-telescope","last_synced_at":"2025-04-27T16:32:14.821Z","repository":{"id":40250326,"uuid":"390404999","full_name":"nvim-neorg/neorg-telescope","owner":"nvim-neorg","description":"Telescope.nvim integration for Neorg","archived":false,"fork":false,"pushed_at":"2025-04-17T05:12:50.000Z","size":133,"stargazers_count":197,"open_issues_count":6,"forks_count":25,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-17T19:51:14.948Z","etag":null,"topics":["neovim-plugin"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nvim-neorg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":"max397574"}},"created_at":"2021-07-28T15:40:24.000Z","updated_at":"2025-04-17T05:12:31.000Z","dependencies_parsed_at":"2023-02-14T09:46:41.514Z","dependency_job_id":"48960d2a-6127-4211-9524-4dfc84668acf","html_url":"https://github.com/nvim-neorg/neorg-telescope","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fneorg-telescope","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fneorg-telescope/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fneorg-telescope/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fneorg-telescope/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nvim-neorg","download_url":"https://codeload.github.com/nvim-neorg/neorg-telescope/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251171579,"owners_count":21547112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["neovim-plugin"],"created_at":"2024-08-03T13:01:42.070Z","updated_at":"2025-04-27T16:32:14.527Z","avatar_url":"https://github.com/nvim-neorg.png","language":"Lua","funding_links":["https://github.com/sponsors/max397574"],"categories":["Lua","Integrations"],"sub_categories":[],"readme":"# Neorg Telescope\n\nThis repo hosts a 3rd party module for [Neorg](https://github.com/nvim-neorg/neorg) to integrate with [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)\n# 🌟 Showcase\n### Fuzzy Searching Any Linkable\nSimply jump to any important element in the workspace. This includes headings, drawers, markers.\nThe command for this is `Telescope neorg find_linkable`\n\n\u003cdetails\u003e\n\u003csummary\u003eDemo\u003c/summary\u003e\n\u003cimg alt=\"find_linkable\" src=\"https://user-images.githubusercontent.com/81827001/153651560-ed0849ec-87c1-4932-81e4-f0188ba8b676.png\"\u003e\n\u003c/details\u003e\n\n### Automatic Link Insertion\nSimply press a key (`\u003cC-l\u003e` in insert mode by default) and select what you want to link to.\n\n`insert_link` only works for elements in the current workspace.\n\n\u003cdetails\u003e\n\u003csummary\u003eDemo\u003c/summary\u003e\n\u003cimg alt=\"insert_link\" src=\"https://user-images.githubusercontent.com/81827001/153646764-650e3c7a-caa8-43e1-aae6-47a3a3290969.png\"\u003e\n\u003c/details\u003e\n\n### Automatic File Link Insertion\nYou can use `Telescope neorg insert_file_link` to insert a link to a neorg file.\nNotice that this only works for files in the current workspace.\nNote: If no file is selected a link to a file with the name of the prompt value\nwill be inserted. This file will be created if you use the link with \n\u003cimg alt=\"neorg's hop\" src=\"https://github.com/nvim-neorg/neorg/wiki/Esupports-Hop\"/\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eDemo\u003c/summary\u003e\n\u003cimg alt=\"insert_file_link\" src=\"https://user-images.githubusercontent.com/81827001/153646847-c43aa368-b5b5-44ac-ba00-b3d98454650d.png\"\u003e\n\u003c/details\u003e\n\n### Fuzzy Searching Headings\nWith `Telescope neorg search_headings` you can search through all the headings in the current file.\n\n\u003cdetails\u003e\n\u003csummary\u003eDemo\u003c/summary\u003e\n\u003cimg alt=\"search_headings\" src=\"https://user-images.githubusercontent.com/81827001/153647155-80f5579f-acc9-489e-9e05-acf31a646bba.png\"\u003e\n\u003c/details\u003e\n\n### Search File and Heading Backlinks\n- `Telescope neorg find_backlinks` - find every line in your workspace that links^* to the current file\n- `Telescope neorg find_header_backlinks` - same but with links to the current file _and_ heading\n\nThese are limited to workspace relative links (ie.\n`{:$/worspace/relative/path:}`) for the sake of simplicity. Both exact\n(`{:$/path:** lvl 2 heading}`) and fuzzy (`{:$/path:# heading}`) links are\nfound.\n\n\u003cdetails\u003e\n  \u003csummary\u003eDemo\u003c/summary\u003e\n\n![search backlink](https://github.com/nvim-neorg/neorg-telescope/assets/56943754/37a5b68f-29b3-43ae-a679-9656cfa646db)\n\u003c/details\u003e\n\n## Gtd Pickers\n### Those pickers are all broken since gtd was removed in core\n\u003cdetails\u003e\n\u003csummary\u003eThe removed pickers\u003c/summary\u003e\n\n### Find Project Tasks\nUse `Telescope neorg find_project_tasks` to pick a project and then the tasks inside it.\nYou can then jump to those tasks.\nIf you select and empty project (colored gray) then you'll jump to the project.\n\n\u003cvideo alt=\"find_project_tasks\" src=\"https://user-images.githubusercontent.com/81827001/158395250-b4de0f8b-c693-4f55-ae6e-c66f6055f741.mov\"\u003e\u003c/video\u003e\n\n### Find Context Tasks\nWith `Telescope neorg find_context_tasks` you pick a context and then tasks.\n\u003cvideo alt=\"find_context_tasks\" src=\"https://user-images.githubusercontent.com/81827001/158401579-ef8e7d9a-2d84-4e05-8f7d-d1f3815a67ee.mov\"\u003e\u003c/video\u003e\n\n### Find AOF Tasks\nYou can use `Telescope neorg find_aof_tasks` to pick an aof and then search through the tasks of it.\n\u003cvideo alt=\"find_aof_tasks\" src=\"https://user-images.githubusercontent.com/81827001/158401242-5d61c18a-ab77-4942-ad31-0e6dede410df.mov\"\u003e\u003c/video\u003e\n\n### Find AOF Project Tasks\nWhen you use `Telescope neorg find_aof_project_tasks` you can pick an area of focus, then a project inside it and last but not least you can search for tasks inside the project.\n\u003cvideo alt=\"find_aof_project_tasks\" src=\"https://user-images.githubusercontent.com/81827001/158401841-9ca3a311-bac1-4733-9a6e-6125003d8a38.mov\"\u003e\u003c/video\u003e\n\u003c/details\u003e\n\nUntil the new GTD infrastructure arrives, you could collect all your todo items with a regex, for example:\n\n```lua\n-- Make sure you have ripgrep installed.\n-- Add the following function to your `~/.config/nvim/init.lua`:\ndo\n    local _, neorg = pcall(require, \"neorg.core\")\n    local dirman = neorg.modules.get_module(\"core.dirman\")\n    local function get_todos(dir, states)\n        local current_workspace = dirman.get_current_workspace()\n        local dir = current_workspace[2]\n        require('telescope.builtin').live_grep{ cwd = dir }\n        vim.fn.feedkeys('^ *([*]+|[-]+) +[(]' .. states .. '[)]')\n    end\n\n    -- This can be bound to a key\n    vim.keymap.set('n', '\u003cc-t\u003e', function() get_todos('~/notes', '[^x_]') end)\nend\n```\n\n# 🔧 Installation\nFirst, make sure to pull this plugin down. This plugin does not run any code in of itself. It requires Neorg\nto load it first:\n\nYou can install it through your favorite plugin manager:\n\n- \n  \u003cdetails\u003e\n  \u003csummary\u003e\u003ca href=\"https://github.com/wbthomason/packer.nvim\"\u003epacker.nvim\u003c/a\u003e\u003c/summary\u003e\n\n  ```lua\n  use {\n      \"nvim-neorg/neorg\",\n      config = function()\n          require('neorg').setup {\n              load = {\n                  [\"core.defaults\"] = {},\n                  ...\n                  [\"core.integrations.telescope\"] = {}\n              },\n          }\n      end,\n      requires = { \"nvim-lua/plenary.nvim\", \"nvim-neorg/neorg-telescope\" },\n  }\n  ```\n\n- \u003cdetails\u003e\n  \u003csummary\u003e\u003ca href=\"https://github.com/junegunn/vim-plug\"\u003evim-plug\u003c/a\u003e\u003c/summary\u003e\n\n  ```vim\n  Plug 'nvim-neorg/neorg' | Plug 'nvim-lua/plenary.nvim' | Plug 'nvim-neorg/neorg-telescope'\n  ```\n\n  You can then put this initial configuration in your `init.vim` file:\n\n  ```vim\n  lua \u003c\u003c EOF\n  require('neorg').setup {\n    load = {\n        [\"core.defaults\"] = {},\n        ...\n        [\"core.integrations.telescope\"] = {}\n    },\n  }\n  EOF\n  ```\n\n  \u003c/details\u003e\n- \u003cdetails\u003e\n  \u003csummary\u003e\u003ca href=\"https://github.com/folke/lazy.nvim\"\u003elazy.nvim\u003c/a\u003e\u003c/summary\u003e\n\n  ```lua\n  require(\"lazy\").setup({\n      {\n          \"nvim-neorg/neorg\",\n          opts = {\n              load = {\n                  [\"core.defaults\"] = {},\n                  ...\n                  [\"core.integrations.telescope\"] = {},\n              },\n          },\n          dependencies = { { \"nvim-lua/plenary.nvim\" }, { \"nvim-neorg/neorg-telescope\" } },\n      }\n  })\n  ```\n\n  \u003c/details\u003e\n\n# Configuration\n\nThis module accepts the following configuration with the shown defaults:\n```lua\n{\n    ...\n    [\"core.integrations.telescope\"] = {\n        config = {\n            insert_file_link = {\n                -- Whether to show the title preview in telescope. Affects performance with a large\n                -- number of files.\n                show_title_preview = true,\n            },\n        }\n    }\n}\n```\n\n# Usage\nYou can define keybindings like this:\n\n```lua\nvim.keymap.set(\"n\", \"\u003clhs\u003e\", \"\u003cPlug\u003e(neorg.telescope.search_headings)\")\n```\n\nList of all available plug mappings:\n- `neorg.telescope.backlinks.file_backlinks`\n- `neorg.telescope.backlinks.header_backlinks`\n- `neorg.telescope.find_linkable`\n- `neorg.telescope.find_norg_files`\n- `neorg.telescope.insert_file_link`\n- `neorg.telescope.insert_link`\n- `neorg.telescope.search_headings`\n- `neorg.telescope.switch_workspace`\n\n# Support Welcome\nIf it's not clear by the code already, I'm a solid noob at telescope related things :)\n\nIf you have any awesome ideas or any code you want to contribute then go ahead!\nAny sort of help is appreciated :heart:\n\n#### Some Ideas Right Off The Top Of My Head\n- Fuzzy searching content in paragraphs only\n- Fuzzy searching content in the current heading\n\n# GIFs\n### Insert Link\n![insert_link_gif](https://user-images.githubusercontent.com/81827001/153654205-250d4dcc-014a-46ac-a68d-df7d0432ce58.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvim-neorg%2Fneorg-telescope","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnvim-neorg%2Fneorg-telescope","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvim-neorg%2Fneorg-telescope/lists"}