nnn/plugins/README.md

162 lines
8.6 KiB
Markdown
Raw Normal View History

2019-09-30 21:48:21 +00:00
<h1 align="center">nnn plugins</h1>
2019-11-17 17:58:32 +00:00
<p align="center"><img src="https://i.imgur.com/SpT0L2W.png" /></p>
<p align="center"><i>read ebooks with plugin gutenread (Android)</i></p>
2019-09-30 21:48:21 +00:00
<p align="center"><img src="https://i.imgur.com/14iPDIq.png" /></p>
2019-11-22 12:21:13 +00:00
<p align="center"><i>image preview with plugin imgthumb</i></p>
2019-09-30 21:48:21 +00:00
2019-11-17 17:58:32 +00:00
## Introduction
2019-11-02 15:16:50 +00:00
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.
2019-06-26 06:15:33 +00:00
2019-11-17 17:58:32 +00:00
## List of plugins
2019-06-26 06:15:33 +00:00
2019-11-21 16:44:25 +00:00
| Plugin (a-z) | Description | Lang | Deps |
2019-04-18 04:59:47 +00:00
| --- | --- | --- | --- |
2019-11-21 16:44:25 +00:00
| boom | Play random music from dir | sh | [moc](http://moc.daper.net/) |
| dups | List non-empty duplicate files in current dir | sh | find, md5sum,<br>sort uniq xargs |
2019-11-22 12:21:13 +00:00
| chksum | Create and verify checksums | sh | md5sum,<br>sha256sum |
| diffs | Diff for selection (limited to 2 for directories) | sh | vimdiff |
2019-11-21 16:44:25 +00:00
| dragdrop | Drag/drop files from/into nnn | sh | [dragon](https://github.com/mwh/dragon) |
| exetoggle | Toggle executable status of hovered file | sh | chmod |
| fzcd | Change to the directory of a fuzzy-selected file/dir | sh | fzy/fzf<br>(optional fd) |
| fzhist | Fuzzy-select a cmd from history, edit in $EDITOR and run | sh | fzy |
| fzopen | Fuzzy find a file in dir subtree and edit or xdg-open | sh | fzy, xdg-open |
| getplugs | Update plugins | sh | curl |
| gutenread | Browse, download, read from Project Gutenberg | sh | curl, unzip, w3m<br>[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) |
2019-11-22 12:21:13 +00:00
| imgsxiv | 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 |
| imgthumb | View thumbnail of an image or dir of images | sh | [lsix](https://github.com/hackerb9/lsix) |
2019-11-21 16:44:25 +00:00
| imgur | Upload an image to imgur (from [imgur-screenshot](https://github.com/jomo/imgur-screenshot)) | bash | - |
2019-11-22 12:21:13 +00:00
| imgviu | View an image or images in dir in `$PAGER` | sh | [viu](https://github.com/atanunq/viu), less |
2019-11-21 16:44:25 +00:00
| ipinfo | Fetch external IP address and whois information | sh | curl, whois |
| kdeconnect | Send selected files to an Android device | sh | kdeconnect-cli |
| 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 |
| notes | Open a quick notes file/dir in `$EDITOR` | sh | - |
| oldbigfile | List large files by access time | sh | find, sort |
| organize | Auto-organize files in directories by file type | sh | file |
| pastebin | Paste contents of a text a file ix.io | sh | - |
2019-11-22 12:21:13 +00:00
| pdfread | Read a PDF or text file aloud | sh | pdftotext, mpv,<br>pico2wave |
2019-11-21 16:44:25 +00:00
| pdfview | View PDF file in `$PAGER` | sh | pdftotext/<br>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 | fzy, sudo/doas |
| 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 |
| transfer | Upload file to transfer.sh | sh | curl |
| 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 |
| vidthumb | Show video thumbnails in terminal | sh | [ffmpegthumbnailer](https://github.com/dirkvdb/ffmpegthumbnailer),<br>[lsix](https://github.com/hackerb9/lsix) |
| wall | Set wallpaper or change colorscheme | sh | nitrogen/pywal |
2019-04-18 04:59:47 +00:00
2019-08-17 06:29:39 +00:00
## Installing plugins
2019-04-30 03:06:55 +00:00
2019-09-27 15:31:55 +00:00
The following command installs 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`. You can run the `getplugs` plugin later to update the plugins. It backs up earlier plugins.
2019-04-30 03:06:55 +00:00
2019-05-05 02:50:35 +00:00
**NOTE:** `getplugs` also downloads the launcher `nlaunch` and tries to place it at `/usr/local/bin/` using `sudo`. If it fails you have to place `nlauch` manually somewhere in your `$PATH`.
2019-04-30 03:06:55 +00:00
2019-09-27 16:25:02 +00:00
## Executing plugins
2019-06-03 04:57:01 +00:00
2019-09-27 16:25:02 +00:00
**Method 1:** Directly with <kbd>:key</kbd>:
2019-06-03 04:57:01 +00:00
2019-11-22 12:21:13 +00:00
export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb'
2019-11-17 07:38:26 +00:00
Now plugin `fzopen` can be run with the keybind <kbd>:o</kbd>, `mocplay` can be run with <kbd>:p</kbd> and so on... The key vs. plugin pairs are shown in the help and config screen.
2019-11-16 05:56:19 +00:00
**Method 2:** Use the _pick plugin_ shortcut to visit the plugin directory and execute a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory.
## Running commands as plugin
2019-10-25 02:20:54 +00:00
To assign keys to arbitrary non-background cli commands (non-shell-interpreted) and invoke like plugins, add `_` (underscore) before the command. For example:
2019-11-23 20:43:27 +00:00
export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen'
2019-11-16 05:56:19 +00:00
Now <kbd>:x</kbd> can be used to make a file executable, <kbd>:g</kbd> can be used to the git log of a git project directory, <kbd>:s</kbd> can be used to preview a partially downloaded media file.
Notes:
2019-11-23 20:43:27 +00:00
1. Use single quotes for `$NNN_PLUG` so `$nnn` is not interpreted
2. `$nnn` should be the last argument (IF you want to pass the hovered file name)
2019-11-16 05:56:19 +00:00
3. (_Again_) add `_` before the command
2019-10-24 13:24:33 +00:00
## Access level of plugins
When `nnn` executes a plugin, it does the following:
- Change 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). Note that the second argument is not passed in case of commands starting with `_`.
- Sets the environment variable `NNN_PIPE` used to control `nnn` active directory.
2019-11-22 12:21:13 +00:00
Plugins can also access the current selections by reading the `.selections` file in the config directory (See the `diffs` plugin for example).
2019-10-24 13:24:33 +00:00
## Create your own plugins
Plugins are a powerful yet easy way to extend the capabilities of `nnn`.
2019-09-06 14:33:48 +00:00
Plugins are scripts that can be written in any scripting language. However, POSIX-compliant shell scripts runnable in `sh` are preferred.
2019-09-06 14:33:48 +00:00
Each script has a _Description_ section which provides more details on what the script does, if applicable.
The plugins reside in `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
#### 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 `<number><path>` 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).
2019-08-17 06:29:39 +00:00
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.
2019-08-17 06:29:39 +00:00
#### Examples
There are many plugins provided by `nnn` which can be used as examples. Here are a few simple selected examples.
2019-08-17 06:29:39 +00:00
- Show the git log of changes to the particular file along with the code for a quick and easy review.
```sh
2019-08-17 06:29:39 +00:00
#!/usr/bin/env sh
git log -p -- "$1"
```
- Change to directory in clipboard using helper script
```sh
#!/usr/bin/env sh
2019-10-23 13:55:57 +00:00
. $(dirname $0)/.nnn-plugin-helper
nnn_cd "$(xsel -ob)"
```
2019-08-17 06:29:39 +00:00
- Change direcory to the location of a link using helper script with specific context (current)
```sh
#!/usr/bin/env sh
2019-10-23 13:55:57 +00:00
. $(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"
```
2019-08-17 06:29:39 +00:00
## Contributing plugins
Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.
2019-04-18 04:59:47 +00:00
2019-04-18 14:57:35 +00:00
The plugins should be executable. Please add an entry in the table above.