https://github.com/stelcodes/bunny.yazi

🐰 Simple bookmarks plugin for yazi with fuzzy search and directory marking
https://github.com/stelcodes/bunny.yazi

Last synced: about 2 months ago
JSON representation

🐰 Simple bookmarks plugin for yazi with fuzzy search and directory marking

• Host: GitHub
• URL: https://github.com/stelcodes/bunny.yazi
• Owner: stelcodes
• License: mit
• Created: 2024-11-13T22:09:09.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-15T06:57:29.000Z (2 months ago)
• Last Synced: 2024-11-15T07:20:18.299Z (2 months ago)
• Language: Lua
• Homepage:
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🐰 bunny.yazi

*🩷 Hop around your filesystem 🩷*

This is an intentionally simple directory bookmark plugin for [yazi](https://github.com/sxyazi/yazi).

- Define bookmarks (aka **hops**) in lua

- Change directory via key or fuzzy search with [fzf](https://github.com/junegunn/fzf) or any other compatible program

- Mark a directory (one at a time) for hopping quickly

- Single menu for all functionality, therefore only one keymap is required

- No filesystem changes whatsoever



## Installation

### With `yapack`

```sh

ya pack -a stelcodes/bunny

```

### With Nix (Home Manager + flakes)

`flake.nix`:

```nix

inputs = {

  bunny-yazi = {

    url = "github:stelcodes/bunny.yazi";

    flake = false;

  };

};

```

Home Manager config:

```nix

programs.yazi = {

  plugins.bunny = builtins.toString inputs.bunny-yazi;

  initLua = ''

    require("bunny"):setup({ ... })

  '';

  keymap.manager.prepend_keymap = [

    { on = "'"; run = "plugin bunny"; desc = "Start bunny.yazi"; }

  ];

};

```

## Configuration

`~/.config/yazi/init.lua`:

```lua

local home = os.getenv("HOME")

require("bunny"):setup({

  hops = {

    { tag = "home", path = home, key = "h" },

    { tag = "nix-store", path = "/nix/store", key = "n" },

    { tag = "nix-config", path = home.."/.config/nix", key = "c" },

    { tag = "config", path = home.."/.config", key = "C" },

    { tag = "local", path = home.."/.local", key = "l" },

    { tag = "tmp-home", path = home.."/tmp", key = "t" },

    { tag = "tmp", path = "/tmp", key = "T" },

    { tag = "downloads", path = home.."/downloads", key = "d" },

    { tag = "music", path = home.."/music", key = "m" },

    { tag = "rekordbox", path = home.."/music/dj-tools/rekordbox", key = "r" },

  },

  notify = true, -- notify after hopping, default is false

  fuzzy_cmd = "sk", -- fuzzy searching command, default is fzf

})

```

`~/.config/yazi/yazi.toml`:

```toml

[[manager.prepend_keymap]]

desc = "Start bunny.yazi"

on = "'"

run = "plugin bunny"

```

## Inspiration

[yamb.yazi](https://github.com/h-hg/yamb.yazi)

[nnn bookmarks](https://github.com/jarun/nnn/wiki/Basic-use-cases#add-bookmarks)