diff options
| author |  Arun Prakash Jana <engineerarun@gmail.com> | 2019-04-18 20:27:35 +0530 |
|---|---|---|
| committer | Arun Prakash Jana <engineerarun@gmail.com> | 2019-04-18 20:32:53 +0530 |
| commit | 5cf34717161bd866a634d8a9ad209afb4004857b (patch) | |
| tree | e63a1f4849c7ebb7658725a4369caa48a0710af4 /plugins/README.md | |
| parent | 12ce9451ee1c24ad245d33e8944ba77a1108b5b2 (diff) | |
| download | nnn-5cf34717161bd866a634d8a9ad209afb4004857b.tar.gz | |
Plugins!
Diffstat (limited to 'plugins/README.md')
| -rw-r--r-- | plugins/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/plugins/README.md b/plugins/README.md new file mode 100644 index 0000000..be8aa4c --- /dev/null +++ b/plugins/README.md @@ -0,0 +1,29 @@ +| Plugin (a-z) | Lang | Deps | Description | +| --- | --- | --- | --- | +| edit | sh | fzy | Fuzzy find a file in directory subtree and edit in vim | +| fzy | sh | fzy | Fuzzy find a file in directory subtree and open using xdg-open | +| hexview | sh | xxd, $PAGER | view a file in hex | +| imgresize | sh | [imgp](https://github.com/jarun/imgp) | Resize images in directory to screen resolution | +| imgur | bash | [imgur](https://github.com/jomo/imgur-screenshot) | Upload an image to imgur | +| kdeconnect | sh | kdeconnect-cli | Send selected files to an Android device | +| ndiff | sh | vimdiff | File and directory diff for selection | +| nwal | sh | nitrogen | Set the selected image as wallpaper using nitrogen | +| paste | sh | [pastebinit](https://launchpad.net/pastebinit) | Paste contents of current (text) file to paste.ubuntu.com | +| picker | sh | nnn | Pick files and pipe the newline-separated list to another utility | +| pywal | sh | pywal | Set selected image as wallpaper, change terminal color scheme | +| sxiv | sh | sxiv | Open images in a dir in sxiv, set wallpaper, copy path ([tips](https://wiki.archlinux.org/index.php/Sxiv#Assigning_keyboard_shortcuts))| +| transfer | sh | curl | Upload current file to transfer.sh | +| upgrade | sh | wget | Upgrade to latest nnn version manually on Debian 9 Stretch | + +### File access from plugins + +The design is flexible so a plugin can access: +- all files in the directory (`nnn` switches to the dir where the plugin is to be run so the dir is `$PWD` for the plugin) +- the currently highlighted file (the file name is passed as the argument to a plugin) +- the current selection (by reading the file .nnncp, see the plugin `ndiff`) + +### Contributing plugins + +Plugins are scripts and all scripting languages should work. However, POSIX-compliant shell scripts runnable in `sh` are preferred. If that's too rudimentary for your use case, use Python, Perl or Ruby. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised. + +The plugins should be executable. Please add an entry in the table above. |