nnn plugins

read ebooks with plugin gutenread (Android)

image preview with plugin imgthumb

## Introduction Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or binaries) which `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins. ## Installing plugins The following command installs or updates (after backup) all plugins: curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/plugins/getplugs | sh Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. ## List of plugins | Plugin (a-z) | Description | Lang | Deps | | --- | --- | --- | --- | | autojump | Navigate to dir/path (**autojump stores navigation patterns**) | sh | autojump | | boom | Play random music from dir | sh | [moc](http://moc.daper.net/) | | dups | List non-empty duplicate files in current dir | sh | find, md5sum,
sort uniq xargs | | chksum | Create and verify checksums | sh | md5sum,
sha256sum | | diffs | Diff for selection (limited to 2 for directories) | sh | vimdiff | | dragdrop | Drag/drop files from/into nnn | sh | [dragon](https://github.com/mwh/dragon) | | fzcd | Change to the directory of a fuzzy-selected file/dir | sh | fzf/fzy
fd/fdfind/find | | fzhist | Fuzzy-select a cmd from history, edit in `$EDITOR` and run | sh | fzf/fzy | | fzopen | Fuzzy find a file in dir subtree and edit or open | sh | fzf/fzy, xdg-open | | getplugs | Update plugins | sh | curl | | gutenread | Browse, download, read from Project Gutenberg | sh | curl, unzip, w3m
[epr](https://github.com/wustho/epr) (optional) | | hexview | View a file in hex in `$PAGER` | sh | xxd | | imgresize | Resize images in dir to screen resolution | sh | [imgp](https://github.com/jarun/imgp) | | imgthumb | View thumbnail of an image or dir of images | sh | [lsix](https://github.com/hackerb9/lsix) | | imgur | Upload an image to imgur (from [imgur-screenshot](https://github.com/jomo/imgur-screenshot)) | bash | - | | imgview | Browse images, set wallpaper, copy path ([config](https://wiki.archlinux.org/index.php/Sxiv#Assigning_keyboard_shortcuts)), [rename](https://github.com/jarun/nnn/wiki/Basic-use-cases#browse-rename-images)| sh | sxiv/[viu](https://github.com/atanunq/viu), less| | ipinfo | Fetch external IP address and whois information | sh | curl, whois | | kdeconnect | Send selected files to an Android device | sh | kdeconnect-cli | | launch | GUI application launcher | sh | fzf/fzy | | mediainf | Show media information | sh | mediainfo | | moclyrics | Show lyrics of the track playing in moc | sh | [ddgr](https://github.com/jarun/ddgr), [moc](http://moc.daper.net/) | | mocplay | Append (and/or play) selection/dir/file in moc | sh | [moc](http://moc.daper.net/) | | nmount | Toggle mount status of a device as normal user | sh | pmount, udisks2 | | nuke | Sample file opener (CLI-only by default) | sh | various | | oldbigfile | List large files by access time | sh | find, sort | | organize | Auto-organize files in directories by file type | sh | file | | pdfread | Read a PDF or text file aloud | sh | pdftotext, mpv,
pico2wave | | pdfview | View PDF file in `$PAGER` | sh | pdftotext/
mupdf-tools | | picker | Pick files and list one per line (to pipe) | sh | nnn | | pskill | Fuzzy list by name and kill process or zombie | sh | fzf/fzy, ps,
sudo/doas | | renamer | Batch rename selection or files in dir | sh | [qmv](https://www.nongnu.org/renameutils/)/[vidir](https://joeyh.name/code/moreutils/) | | ringtone | Create a variable bitrate mp3 ringtone from file | sh | date, ffmpeg | | splitjoin | Split file or join selection | sh | split, cat | | suedit | Edit file using superuser permissions | sh | sudoedit/sudo/doas | | treeview | Informative tree output in `$EDITOR` | sh | tree | | uidgid | List user and group of all files in dir | sh | ls, less | | upgrade | Upgrade nnn manually on Debian 9 Stretch | sh | curl | | upload | Paste text to ix.io, upload binary to file.io | sh | curl, jq, tr | | vidthumb | Show video thumbnails in terminal | sh | [ffmpegthumbnailer](https://github.com/dirkvdb/ffmpegthumbnailer),
[lsix](https://github.com/hackerb9/lsix) | | wall | Set wallpaper or change colorscheme | sh | nitrogen/pywal | ## Invoking a plugin Use the plugin shortcut (;key or ^Skey) to list the defined plugin keys and press the required key. E.g., with the below config: export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb' Plugin `fzopen` can be run with the keybind ;o, `mocplay` can be run with ;p and so on... The key vs. plugin pairs are shown in the help and config screen. A maximum of 15 keys can be defined. To select and invoke a plugin from the plugin directory, press Enter (to _enter_ the plugin dir) after the plugin shortcut. #### Skip directory refresh after running a plugin `nnn` refreshes the directory after running a plugin to reflect any changes by the plugin. To disable this (say while running the `mediainfo` plugin on some filtered files), add a `-` before the plugin name: export NNN_PLUG='m:-mediainfo' Now `nnn` will not refresh the directory after running the `mediainfo` plugin. ## Running commands as plugin To assign keys to arbitrary non-background, non-shell-interpreted cli commands and invoke like plugins, add `_` (underscore) before the command. For example: export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen' Now ;x can be used to make a file executable, ;g can be used to the git log of a git project directory, ;s can be used to preview a partially downloaded media file. #### Skip user confirmation after command execution `nnn` waits for user confirmation (the prompt `Press Enter to continue`) after it executes a command as plugin (unlike plugins which can add a `read` to wait). To skip this, add a `*` after the command. For example: export NNN_PLUG='s:_smplayer $nnn*;n:-_vim /home/vaio/Dropbox/Public/synced_note*' Now there will be no prompt after ;s and ;n. Notes: 1. Use single quotes for `$NNN_PLUG` so `$nnn` is not interpreted 2. `$nnn` should be the last argument (IF used) 3. (_Again_) add `_` before the command 4. To disable directory refresh after running a _command as plugin_, prefix with `-_` #### Some useful key-command examples | Key:Command | Description | |---|---| | `e:-_vi $nnn*` | Edit hovered file in vi | | `k:-_fuser -kiv $nnn*` | Interactively kill process(es) using hovered file | | `l:_git log` | Show git log | | `n:-_vi /home/user/Dropbox/dir/note*` | Take quick notes in a synced file/dir of notes | | `p:-_less -iR $nnn*` | Page through hovered file in less | | `s:_smplayer -minigui $nnn*` | Play hovered media file, even unfinished download | | `x:_chmod +x $nnn` | Make the hovered file executable | | `y:-_sync*` | Flush cached writes | ## Access level of plugins When `nnn` executes a plugin, it does the following: - Changes to the directory where the plugin is to be run (`$PWD` pointing to the active directory) - Passes two arguments to the script: 1. The hovered file's name. 2. The working directory (might differ from `$PWD` in case of symlinked paths; non-canonical). - Sets the environment variable `NNN_PIPE` used to control `nnn` active directory. Plugins can also read the `.selection` file in the config directory. ## Create your own plugins Plugins can be written in any scripting language. However, POSIX-compliant shell scripts runnable in `sh` are preferred. Drop the plugin in `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins` and make it executable. Optionally add a hotkey in `$NNN_PLUG` for frequent usage. #### Controlling `nnn`'s active directory `nnn` provides a mechanism for plugins to control its active directory. The way to do so is by writing to the pipe pointed by the environment variable `NNN_PIPE`. The plugin should write a single string in the format `` without a newline at the end. For example, `1/etc`. The number indicates the context to change the active directory of (0 is used to indicate the current context). For convenience, we provided a helper script named `.nnn-plugin-helper` and a function named `nnn_cd` to ease this process. `nnn_cd` receives the path to change to as the first argument, and the context as an optional second argument. If a context is not provided, it is asked for explicitly. Usage examples can be found in the Examples section below. #### Examples There are many plugins provided by `nnn` which can be used as examples. Here are a few simple selected examples. - Show the git log of changes to the particular file along with the code for a quick and easy review. ```sh #!/usr/bin/env sh git log -p -- "$1" ``` - Change to directory in clipboard using helper script ```sh #!/usr/bin/env sh . $(dirname $0)/.nnn-plugin-helper nnn_cd "$(xsel -ob)" ``` - Change directory to the location of a link using helper script with specific context (current) ```sh #!/usr/bin/env sh . $(dirname $0)/.nnn-plugin-helper nnn_cd "$(dirname $(readlink -fn $1))" 0 ``` - Change to arbitrary directory without helper script ```sh #!/usr/bin/env sh printf "cd to: " read -r dir printf "%s" "0$dir" > "$NNN_PIPE" ``` ## Contributing plugins 1. Add informative sections like _Description_, _Notes_, _Dependencies_, _Shell_, _Author_ etc. in the plugin. 2. Add an entry in the table above. 3. Keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised. 4. The plugin file should be executable.