https://github.com/nvim-telescope/telescope-z.nvim

Z integration for Telescope
https://github.com/nvim-telescope/telescope-z.nvim

Last synced: 3 months ago
JSON representation

Z integration for Telescope

• Host: GitHub
• URL: https://github.com/nvim-telescope/telescope-z.nvim
• Owner: nvim-telescope
• Created: 2021-01-27T12:29:55.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-17T23:47:12.000Z (about 1 year ago)
• Last Synced: 2024-06-25T22:40:26.440Z (4 months ago)
• Language: Lua
• Size: 25.4 KB
• Stars: 35
• Watchers: 6
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# telescope-z.nvim

`telescope-z` is an extension for [telescope.nvim][] that provides its users with operating [rupa/z][] or its compatibles.

[telescope.nvim]: https://github.com/nvim-telescope/telescope.nvim

[rupa/z]: https://github.com/rupa/z

## Installation

### for lazy.nvim

```lua

{

  "nvim-telescope/telescope-z.nvim",

  config = function()

    require("telescope").load_extension "z"

  end,

}

```

### for paq-nvim

```lua

paq "nvim-telescope/telescope-z.nvim"

require("telescope").load_extension "z"

```

## Usage

```vim

:Telescope z

```

Or Lua way

```lua

require("telescope").extensions.z.z {}

```

List directories by `z -l`. In default, it does actions below when you input keys.

| key               | action               |

|-------------------|----------------------|

| `` (edit)     | `builtin.find_files` |

| `` (split)   | `:chdir` to the dir  |

| `` (vsplit)  | `:lchdir` to the dir |

| `` (tabedit) | `:tchdir` to the dir |

#### options

##### `cmd`

Set command list to execute `z -l` or compatibles. In default, it does `bash -c 'z -l'` or so.

Default value: `{ vim.o.shell, "-c", "z -l" }`

#### `cwd`

Transform the result paths into relative ones with this value as the base dir.

Default value: `vim.uv.cwd()`

#### `tail_path` (deprecated)

***This is deprecated. Use `path_display` (`:h telescope.defaults.path_display`).***

Show only basename of the path.

Default value: `false`

#### `shorten_path` (deprecated)

***This is deprecated. Use `path_display` (`:h telescope.defaults.path_display`).***

Call `pathshorten()` for each path.

Default value: `false`