https://github.com/romgrk/kirby.nvim

Fuzzy picker for neovim - using kitty graphics protocol
https://github.com/romgrk/kirby.nvim

Last synced: about 2 months ago
JSON representation

Fuzzy picker for neovim - using kitty graphics protocol

• Host: GitHub
• URL: https://github.com/romgrk/kirby.nvim
• Owner: romgrk
• License: other
• Created: 2023-02-11T05:55:56.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-07-14T04:47:26.000Z (about 1 year ago)
• Last Synced: 2024-07-03T13:23:32.553Z (3 months ago)
• Language: Lua
• Homepage:
• Size: 1.06 MB
• Stars: 140
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kirby.nvim

Fuzzy picker based on [kui.nvim](https://github.com/romgrk/kui.nvim).

###### Table of contents

 - [Installation](#installation)

 - [Usage](#usage)

 - [Adding pickers](#adding-pickers)

![multiline](./assets/picker-multiline.png)

![singleline](./assets/picker-singleline.png)

## Installation

This plugin depends on the ones listed below. If you're using lazy.nvim, you can use the config below.

It also has the following hard dependencies that you need to ensure.

 - POSIX-compliant enough OS

 - libcairo

 - terminal with kitty graphics protocol support

```lua

{ 'romgrk/kirby.nvim', dependencies = {

    { 'romgrk/fzy-lua-native', build = 'make install' },

    { 'romgrk/kui.nvim' },

    { 'nvim-tree/nvim-web-devicons' },

    { 'nvim-lua/plenary.nvim' },

  },

},

```

## Usage

This plugin maps `` to opening the file picker, unless that key is already mapped.

Use the `:Kirby [picker-id]` command to open a picker.

### Default pickers

#### `Kirby files [directory]`

Select files in the (current) directory. Uses `fd` if available, otherwise `git ls-files`.

#### `Kirby ctags-current-file`

Select ctags for the current file. Requires `universal-ctags`.

![demo](./assets/picker-ctags.png)

#### `Kirby commands-list`

Select a vim command.

![demo](./assets/picker-commands.png)

#### `Kirby commands-run `

Run a vim command.

![demo](./assets/picker-commands-run.png)

#### `Kirby howdoi`

Copy/paste from stackoverflow. Requires [howdoi](https://github.com/gleitz/howdoi).

#### `Kirby coc-diagnostics`

Diagnostics via coc.nvim.

#### `Kirby coc-workspaces-symbols`

Workspace symbols via coc.nvim.

## Adding pickers

**NOTE**: Expect breaking changes from time to time, this is still evolving.

A few examples from my own config:

```lua

local kirby = require('kirby')

kirby.register({

  id = 'git-branch',

  name = 'Git checkout',

  values = function() return vim.fn['fugitive#CompleteObject']('', ' ', '') end,

  onAccept = 'Git checkout',

})

kirby.register({

  id = 'session',

  name = 'Open session',

  values = function() return vim.fn['xolox#session#complete_names']('', 'OpenSession ', 0) end,

  onAccept = 'OpenSession',

})

kirby.register({

  id = 'note',

  name = 'Open note',

  values = function() return vim.fn['xolox#notes#cmd_complete']('', 'Note ', 0) end,

  onAccept = 'Note',

})

```

See [types.ts](./src/types.ts) for configuration options.

## License

JSON license (MIT license + non-evilness clause)