dotfiles/config/yazi/plugins/restore.yazi/README.md

restore.yazi

• restore.yazi
  • Requirements
  • Installation
    • Linux/MacOS
  • Usage

Yazi plugin to restore/recover latest deleted files/folders.

Requirements

• yazi >= v25.2.7
• trash-cli
  • If you have Can't Get Trash Directory error and running trash-cli --volumes in terminal throw AttributeError: 'PrintVolumesList' object has no attribute 'run_action'. Remove the old version of trash-cli and install newer version How to install.

Installation

Linux

git clone https://github.com/boydaihungst/restore.yazi ~/.config/yazi/plugins/restore.yazi

or

ya pack -a boydaihungst/restore

Usage

1. Key binding

   • Add this to your keymap.toml:

     [manager]
       keymap = [
         { on = "u", run = "plugin restore", desc = "Restore last deleted files/folders" },
         # or use "d + u" like me
         { on = ["d", "u"], run = "plugin restore", desc = "Restore last deleted files/folders" },
         # ... Other keymaps
       ]
     

2. Configuration (Optional)

   • Default:

     require("restore"):setup({
         -- Set the position for confirm and overwrite dialogs.
         -- don't forget to set height: `h = xx`
         -- https://yazi-rs.github.io/docs/plugins/utils/#ya.input
         position = { "center", w = 70, h = 40 }, -- Optional
     
         -- Show confirm dialog before restore.
         -- NOTE: even if set this to false, overwrite dialog still pop up
         show_confirm = true,  -- Optional
     
         -- colors for confirm and overwrite dialogs
         theme = { -- Optional
           -- Default using style from your flavor or theme.lua -> [confirm] -> title.
           -- If you edit flavor or theme.lua you can add more style than just color.
           -- Example in theme.lua -> [confirm]: title = { fg = "blue", bg = "green"  }
           title = "blue", -- Optional. This valid has higher priority than flavor/theme.lua
     
           -- Default using style from your flavor or theme.lua -> [confirm] -> content
           -- Sample logic as title above
           header = "green", -- Optional. This valid has higher priority than flavor/theme.lua
     
           -- header color for overwrite dialog
           -- Default using color "yellow"
           header_warning = "yellow", -- Optional
           -- Default using style from your flavor or theme.lua -> [confirm] -> list
           -- Sample logic as title and header above
           list_item = { odd = "blue", even = "blue" }, -- Optional. This valid has higher priority than flavor/theme.lua
         },
     })