summaryrefslogtreecommitdiff
path: root/fedora/.config/yazi/plugins/mount.yazi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fedora/.config/yazi/plugins/mount.yazi/README.md')
-rw-r--r--fedora/.config/yazi/plugins/mount.yazi/README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/fedora/.config/yazi/plugins/mount.yazi/README.md b/fedora/.config/yazi/plugins/mount.yazi/README.md
new file mode 100644
index 0000000..b35881f
--- /dev/null
+++ b/fedora/.config/yazi/plugins/mount.yazi/README.md
@@ -0,0 +1,48 @@
+# mount.yazi
+
+A mount manager for Yazi, providing disk mount, unmount, and eject functionality.
+
+Supported platforms:
+
+- Linux with [`udisksctl`](https://github.com/storaged-project/udisks), `lsblk` and `eject` both provided by [`util-linux`](https://github.com/util-linux/util-linux)
+- macOS with `diskutil`, which is pre-installed
+
+https://github.com/user-attachments/assets/c6f780ab-458b-420f-85cf-2fc45fcfe3a2
+
+## Installation
+
+```sh
+ya pkg add yazi-rs/plugins:mount
+```
+
+## Usage
+
+Add this to your `~/.config/yazi/keymap.toml`:
+
+```toml
+[[mgr.prepend_keymap]]
+on = "M"
+run = "plugin mount"
+```
+
+Available keybindings:
+
+| Key binding | Alternate key | Action |
+| ------------ | ------------- | --------------------- |
+| <kbd>q</kbd> | - | Quit the plugin |
+| <kbd>k</kbd> | <kbd>↑</kbd> | Move up |
+| <kbd>j</kbd> | <kbd>↓</kbd> | Move down |
+| <kbd>l</kbd> | <kbd>→</kbd> | Enter the mount point |
+| <kbd>m</kbd> | - | Mount the partition |
+| <kbd>u</kbd> | - | Unmount the partition |
+| <kbd>e</kbd> | - | Eject the disk |
+
+## TODO
+
+- Custom keybindings
+- Windows support (I don't use Windows myself, PRs welcome!)
+- Support mount, unmount, and eject the entire disk
+
+## License
+
+This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.