# telescope-bookmarks.nvim
**Repository Path**: mirrors_telescope/telescope-bookmarks.nvim
## Basic Information
- **Project Name**: telescope-bookmarks.nvim
- **Description**: telescope-bookmarks.nvim mirror
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-07
- **Last Updated**: 2022-06-07
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# telescope-bookmarks.nvim
[](https://github.com/dhruvmanila/telescope-bookmarks.nvim/actions/workflows/test.yml)
[](https://codecov.io/gh/dhruvmanila/telescope-bookmarks.nvim)
[](https://github.com/dhruvmanila/telescope-bookmarks.nvim/releases/latest)
[](/LICENSE)
A Neovim Telescope extension to open your browser bookmarks right from the editor!
Screenshot configuration
```lua
require('telescope').extensions.bookmarks.bookmarks(
require('telescope.themes').get_dropdown {
layout_config = {
width = 0.8,
height = 0.8,
},
previewer = false,
}
)
```
Supported browsers on the respective OS:
| Browser |
Operating System |
| MacOS |
Linux |
Windows |
| Google Chrome |
☑️ |
☑️ |
☑️ |
| Google Chrome Beta |
☑️ |
☑️ |
☑️ |
| Brave |
☑️ |
☑️ |
☑️ |
| Safari [1] |
☑️ |
- |
- |
| Firefox |
☑️ |
☑️ |
☑️ |
| Microsoft Edge |
☑️ |
☑️ |
☑️ |
| Vivaldi |
☑️ |
☑️ |
☑️ |
Supported tools:
- [buku](https://github.com/jarun/buku) - bookmark manager
_Please take a look at the [**Caveats**](#caveats) section if you're planning to use this plugin with **Safari**._
## Requirements
[](https://github.com/neovim/neovim)
* [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
* [sqlite.lua](https://github.com/tami5/sqlite.lua) (only for Firefox browser
and buku)
## Installation
Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
'dhruvmanila/telescope-bookmarks.nvim',
-- Uncomment if the selected browser is Firefox
-- requires = {
-- 'tami5/sqlite.lua',
-- }
}
```
Using [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'dhruvmanila/telescope-bookmarks.nvim'
" Uncomment if the selected browser is Firefox
" Plug 'tami5/sqlite.lua'
```
## Telescope Config
Loading the extension:
```lua
require('telescope').load_extension('bookmarks')
```
Extension options:
```lua
require('telescope').setup {
extensions = {
bookmarks = {
-- Available: 'brave', 'buku', 'chrome', 'chrome_beta', 'edge', 'safari', 'firefox', 'vivaldi'
selected_browser = 'brave',
-- Either provide a shell command to open the URL
url_open_command = 'open',
-- Or provide the plugin name which is already installed
-- Available: 'vim_external', 'open_browser'
url_open_plugin = nil,
-- Show the full path to the bookmark instead of just the bookmark name
full_path = true,
-- Provide a custom profile name for Firefox
firefox_profile_name = nil,
},
}
}
```
For Firefox users, the default profile will be used if `firefox_profile_name` is not provided. This is obtained by parsing the profiles config file present in the default config directory.
If the user has provided `url_open_plugin` then it will be used, otherwise default to using `url_open_command`. Supported plugins for `url_open_plugin` and the respective plugin function used to open the URL:
* [open-browser.vim](https://github.com/tyru/open-browser.vim) - `openbrowser#open`
* [vim-external](https://github.com/itchyny/vim-external) - `external#browser`
## Available Commands
```vim
" From the command-line
Telescope bookmarks
" Using lua function
lua require('telescope').extensions.bookmarks.bookmarks(opts)
```
When you press `` on a selected bookmark, it will open the URL using either the `url_open_plugin` or `url_open_command` option in your default browser.
## Caveats
### Safari
The application which is used to run neovim should be allowed full disk access as the bookmarks file (`~/Library/Safari/Bookmarks.plist`) is in a restricted directory. This can be done in ***System Preferences > Security & Privacy > Full Disk Access*** and then click on the checkbox next to your preferred application. Please take a look at the below image for more details:
Allow full disk access to the application running neovim (iTerm2)
## References
* [Browsing Chrome bookmarks with fzf](https://junegunn.kr/2015/04/browsing-chrome-bookmarks-with-fzf/)
* [Code: plist parser](https://codea.io/talk/discussion/1269/code-plist-parser)