restore.yazi

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

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

Requirements

• yazi >= v25.5.31
• 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

ya pkg add boydaihungst/restore

Usage

Important

This plugin restores files and folders based on their deletion date and time. However, since Yazi deletes files in batches of approximately 1000~2000, not all files in a large selection will have the same deletion timestamp. For example, if you select and delete 10,000 files, each batch of 1000~2000 may have a different deletion time. This can result in only a partial restoration of your files (in the worst case, only the last 1000~2000 files deleted). To resolve this, you may need to run the "restore" command multiple times until all desired files are recovered. For instance, to restore 10,000 files, you might have to execute the command up to 10 times.

• Won't work with remote servers in vfs.toml. Since it doesn't support trash: https://yazi-rs.github.io/docs/next/configuration/vfs
• Other types of mount methods should work, but I haven't tested them.

1. Key binding

   • Add this to your keymap.toml. Make it doesn't override other keymaps. Read more about keymap:

     [mgr]
       prepend_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" },
     
         # Select files/folders to restore. Input item index or range separated by comma:
         # - Restore a trashed file:
         #      What file to restore [0..4]: 4
         # - Restore multiple trashed files separated by comma, also support range:
         #      What file to restore [0..3]: 0-2, 3
     
         # This will throw error when there is existed file/folder
         { on = [ "d", "U" ], run = "plugin restore -- --interactive", desc = "Restore deleted files/folders (Interactive)" },
         # Or auto overwrite existed file/folder
         { on = [ "d", "U" ], run = "plugin restore -- --interactive --interactive-overwrite", desc = "Restore deleted files/folders (Interactive overwrite)" },
       ]

2. Configuration (Optional)

   • Default:

     require("restore"):setup({
         -- Set the position for confirm and overwrite prompts.
         -- 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 prompt before restore.
         -- NOTE: even if set this to false, overwrite prompt still pop up
         show_confirm = true,  -- Optional
     
         -- Suppress success notification when all files or folder are restored.
         suppress_success_notification = true,  -- Optional
     
         -- colors for confirm and overwrite prompts
         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 value 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 value has higher priority than flavor/theme.lua
     
           -- header color for overwrite prompt
           -- 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 value has higher priority than flavor/theme.lua
         },
     })