File: README.md Copy Chapter

nnn - *Supercharge your productivity!*

[[Features](https://github.com/jarun/nnn#features)] [[Quickstart](https://github.com/jarun/nnn#quickstart)] [[Plugins](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins)] [[Wiki](https://github.com/jarun/nnn/wiki)]

nnn (n³) is a full-featured terminal file manager. It's tiny (~150 KiB), nearly 0-config and incredibly fast.

It is designed to be unobtrusive with smart workflows to match the trains of thought.

nnn can analyze disk usage, batch rename, launch apps and pick files. The plugin repository has tons of plugins to extend the capabilities further e.g. live previews, (un)mount disks, find & list, file/dir diff, upload files. A patch framework hosts sizable user-submitted patches which are subjective in nature.

Independent (neo)vim plugins - nnn.vim, vim-floaterm nnn wrapper and nnn.nvim (neovim exclusive).

Runs on the Pi, Termux (Android), Linux, macOS, BSD, Haiku, Cygwin, WSL, across DEs or a strictly CLI env.

(more use cases)

Features Copy Chapter

• Quality
  • Privacy-aware (no unconfirmed user data collection)
  • POSIX-compliant, follows Linux kernel coding style
  • Highly optimized, static analysis integrated code
• Frugal
  • Typically needs less than 3.5MB resident memory
  • Works with 8 colors (and xterm 256 colors)
  • Disk-IO sensitive (few disk reads and writes)
  • No FPU usage (all integer maths, even for file size)
  • Minimizes screen refresh with fast line redraws
  • Tiny binary (typically around 100KB)
  • 1-column mode for smaller terminals and form factors
  • Hackable - compile in/out features and dependencies
• Portable
  • Language-agnostic plugins
  • Static binary available (no need to install)
  • Minimal library deps, easy to compile
  • No config file, minimal config with sensible defaults
  • Plugin to backup configuration
  • Widely available on many packagers
  • Touch enabled, handheld-friendly shortcuts
  • Unicode support
• Modes
  • Light (default), detail
  • Disk usage analyzer (block/apparent)
  • File picker, (neo)vim plugin
• Navigation
  • Filter with automatic dir entry on unique match
  • Type-to-nav (turbo navigation/always filter) mode
  • Jump to an entry with visible relative offset
  • Contexts (aka tabs/workspaces) with custom colors
  • Sessions, bookmarks, mark and visit a dir
  • Remote mounts (needs sshfs, rclone)
  • Familiar shortcuts (arrows, ~, -, @), quick look-up
  • cd on quit (easy shell integration)
  • Proceed to next file on file open and selection
• Search
  • Instant filtering with search-as-you-type
  • Fuzzy, regex (POSIX/PCRE2) and string (default) filters
  • Subtree search plugin to open or edit files
• Sort
  • Ordered pure numeric names by default (visit /proc)
  • Case-insensitive version (aka natural) sort
  • By name, access/change/mod (default) time, size, extn
  • Reverse sort
  • Directory-specific ordering
• Mimes
  • Built-in previewer for directory and text files
  • FIFO-based previewer plugins with extensive mime support
  • Open with desktop opener or specify a custom opener
  • File-specific colors (or minimal dirs in context color)
  • Icons and Emojis support (customize and compile-in)
  • Plugin for image, video and audio thumbnails
  • Create, list, extract (to), mount (FUSE based) archives
  • Option to open all text files in $EDITOR
• Convenience
  • Detailed file stats and mime information
  • Run plugins and custom commands with hotkeys
  • FreeDesktop compliant trash utility integration
  • Cross-dir file/all/range selection
  • Create (with parents), rename, duplicate files and dirs
  • Create new file or directory (tree) on startup
  • Batch renamer for selection or dir
  • List input stream of file paths from stdin or plugin
  • Copy (as), move (as), delete, archive, link selection
  • Easily copy, move paths in system clipboard to current dir
  • Dir updates, notification on cp, mv, rm completion
  • Copy file paths to system clipboard on select
  • Launch apps, run commands, spawn a shell, toggle exe
  • Access context paths/files at prompt or spawned shell
  • Lock terminal after configurable idle timeout
  • Capture and show output of a program in help screen
  • Basic support for screen readers and braille displays

Quickstart Copy Chapter

Beginners Copy Section

1. Install nnn, preferbly using the package manager.
2. Run the following command to generate (and optionally add to your rc file) a shell function to start with.
   sh Copy

   sh -c "$(curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/misc/quickstart.sh)"

Use the shell function name you chose to run nnn with your preferred configuration.

Power users Copy Section

1. Install nnn and the dependencies you need.
2. The desktop opener is default. Use -e to open text files in the terminal. Optionally open detached.
3. Configure cd on quit.
4. Sync subshell $PWD to nnn.
5. Install plugins.
6. Use -x to sync selection to clipboard, show notis on cp, mv, rm and set xterm title.
7. For a CLI-only environment, set NNN_OPENER to nuke. Use option -c.
8. Bid ls goodbye! alias ls='nnn -de' :sunglasses:
9. Visit the Live previews and Troubleshooting Wiki pages.

Don't memorize! Arrows, /, q suffice. Tab creates and/or cycles contexts. ? lists shortcuts.

Videos Copy Chapter

• nnn file manager on Termux (Android)
• NNN File Manager
• This Week in Linux 114 - TuxDigital
• nnn file manager basics - Linux
• I'M GOING TO USE THE NNN FILE BROWSER! 😮
• NNN: Is This Terminal File Manager As Good As People Say?
• nnn - A File Manager (By Uoou, again.)

Elsewhere Copy Chapter

• AddictiveTips
• ArchWiki
• FOSSMint
• gHacks Tech News
• Hacker News [1] [2]
• It's FOSS
• Linux Format Issue 265; Manage files with nnn
• LinuxLinks [1] [2] [3]
• Linux Magazine; FOSSPicks
• Make Tech Easier
• Opensource.com
• Open Source For You
• PCLinuxOS Magazine Issue June 2021
• Suckless Rocks
• Ubuntu Full Circle Magazine Issue 135; Review: nnn
• Using and Administering Linux: Volume 2: Zero to SysAdmin: Advanced Topics
• Wikipedia

Developers Copy Chapter

• Arun Prakash Jana (Copyright © 2016-2026)
• 0xACE
• Anna Arad
• KlzXS
• Léo Villeveygoux
• Luuk van Baal
• NRK
• Sijmen J. Mulder
• and other contributors

Visit the Tracker thread for a list of features in progress and anything up for grabs. Feel free to discuss new ideas or enhancement requests.

File: patches/README.md Copy Chapter

User Patch Framework

This directory contains sizable user submitted patches that were rejected from mainline as they tend to be more subjective in nature.

The patches will be adapted on each release when necessary (v4.1 onwards). Each patch can be applied through its respective make variable during compilation. In case inter-patch merge conflicts occur, a compatibility patch is provided and will automatically be applied.

List of patches Copy Chapter

To apply a patch, use the corresponding make variable, e.g.:

make O_NAMEFIRST=1

When contributing/adding a new patch, make sure to add the make variable to the patches array in ./misc/test/check-patches.sh as well so that patch failures can be easily tested.

Resolving patch conflicts Copy Chapter

Patch conflicts can be checked locally by running make checkpatches or by running ./patches/check-patches.sh manually.

Whenever patch conflicts occur on the latest master, pull requests resolving them are welcome. Let's say a conflict occurs in the restorepreview patch. The best way to resolve this conflict would be something along the lines of:

• Ensure you're on latest master and run PATCH_OPTS="--merge" make O_RESTOREPREVIEW=1. This will generate the conflict markers in src/nnn.c.
• Next edit src/nnn.c, resolve the conflicts around the conflict markers(<<<<<<<), and save.
• Then run git diff > patch.diff && sed -i -e "/^$/{r patch.diff" -e "q;}" patches/restorepreview/mainline.diff to update the patch.

File: plugins/README.md Copy Chapter

nnn plugins

Introduction Copy Chapter

Plugins extend the capabilities of nnn. They are executable scripts (or binaries) 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 which can be run with custom hotkeys.

nnn is language-agnostic when it comes to plugins. You can write a plugin in any (scripting) language you are comfortable in!

List of plugins Copy Chapter

Notes:

1. A plugin has to explicitly request nnn to clear the selection e.g. after operating on the selected files.
2. Files starting with a dot in the plugins directory are internal files, listed at the top of the table, and should not be used as plugins directly.

Table of contents Copy Section

• Installation
• Configuration
  • Skip directory refresh after running a plugin
• Running commands as plugin
  • Skip user confirmation after command execution
  • Run a GUI app as plugin
  • Page non-interactive command output
  • Some useful key-command examples
• Access level of plugins
• Create your own plugins
  • Send data to nnn
  • Get notified on file hover
• Examples
• Contributing plugins

Installation Copy Chapter

The following command installs or updates (after backup) all plugins:

sh -c "$(curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/plugins/getplugs)"

Plugins are installed to ${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins.

Configuration Copy Chapter

Set environment variable NNN_PLUG to assign keybinds and invoke plugins directly using the plugin shortcut (;) followed by the assigned key character. E.g., with the below config:

export NNN_PLUG='f:finder;o:fzopen;p:mocq;d:diffs;t:nmount;v:imgview'

plugin finder can be invoked with the keybind ;f, fzopen can be run with ;o and so on... The key vs. plugin pairs are shown in the help and config screen.

Alternatively, combine with Alt (i.e. Alt+key).

To pick and run an unassigned plugin, press Enter (to enter the plugin dir) at the plugin prompt.

To run a plugin at startup, use the option -P followed by the plugin key.

If the plugins list gets too long, try breaking them up into sections:

NNN_PLUG_PERSONAL='g:personal/convert2zoom;p:personal/echo'
NNN_PLUG_WORK='j:work/prettyjson;d:work/foobar'
NNN_PLUG_INLINE='e:!go run "$nnn"*'
NNN_PLUG_DEFAULT='1:ipinfo;p:preview-tui;o:fzz;r:!ratio | sort -nr > ratio*;b:nbak'
NNN_PLUG="$NNN_PLUG_PERSONAL;$NNN_PLUG_WORK;$NNN_PLUG_DEFAULT;$NNN_PLUG_INLINE"
export NNN_PLUG

Note:

• 'g:personal/convert2zoom' will look in the personal sub-folder inside the plugin folder.
• 'b:boom;b:bulknew will result in only the first definition of b (b:boom) being used.
• A keybinding definition of more than 1 character will prevent nnn from starting.

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 add a - before the plugin name:

export NNN_PLUG='p:-plugin'

Running commands as plugin [`!`] Copy Chapter

To assign keys to arbitrary non-background cli commands and invoke like plugins, add ! before the command.

export NNN_PLUG='x:!chmod +x "$nnn";g:!git log;s:!smplayer "$nnn"'

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.

export NNN_PLUG='s:!smplayer "$nnn"*;n:-!vim /home/vaio/Dropbox/Public/synced_note*'

Now there will be no prompt after ;s and ;n.

Note: Do not use * with programs that run and exit e.g. cat.

Run a GUI app as plugin [`&`]

To run a GUI app as plugin, add a & after !.

export NNN_PLUG='m:-!&mousepad "$nnn"'

Page non-interactive command output [`|`]

To show the output of run-and-exit commands which do not need user input, add | (pipe) after !.

export NNN_PLUG='m:-!|mediainfo "$nnn";t:-!|tree -ps;l:-!|ls -lah --group-directories-first'

This option is incompatible with & (terminal output is masked for GUI programs) and ignores * (output is already paged for user).

Notes:

1. Place $nnn (or exported variables) in double quotes ("$nnn")
2. Use single quotes for $NNN_PLUG so "$nnn" is not interpreted
3. (Again) add ! before the command
4. To disable directory refresh after running a command as plugin, prefix with -!

Non-interactive command output in a floating window [`>`]

To show the output of run-and-exit commands in a floating window, add > (right arrow) after !.

export NNN_PLUG='m:!>mediainfo "$nnn";t:!>tree -ps;l:!>ls -lah --group-directories-first'

This option is incompatible with & (terminal output is masked for GUI programs) and ignores * (output is rendered in a floating window).
Option - is ignored with this option. The directory is always refreshed.

Some useful key-command examples

Access level of plugins Copy Chapter

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 three arguments to the script:
  1. $1: The hovered file's name.
  2. $2: The working directory (might differ from $PWD in case of symlinked paths; non-canonical).
  3. $3: The picker mode output file (- for stdout) if nnn is executed as a file picker.
• Sets the environment variable NNN_PIPE used to control nnn active directory.
• Sets the environment variable NNN_INCLUDE_HIDDEN to 1 if hidden files are active, 0 otherwise.
• Sets the environment variable NNN_PREFER_SELECTION to 1 if user prefers to use selection (see nnn's -u flag), 0 otherwise.
• Exports the special variables.

Plugins can also read the .selection file in the config directory.

Create your own plugins Copy Chapter

Plugins can be written in any scripting language. However, POSIX-compliant shell scripts runnable in sh are preferred.

Make the file executable. Drop it in the plugin directory. Optionally add a hotkey in $NNN_PLUG for frequent usage.

Send data to `nnn`

nnn provides a mechanism for plugins to send data to nnn to control its active directory or invoke the list mode.
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 (<->)<ctxcode><opcode><data> without a newline at the end. For example, 1c/etc.

The optional - at the beginning of the stream instructs nnn to clear the selection.
In cases where the data transfer to nnn has to happen while the selection file is being read (e.g. in a loop), the plugin should
create a tmp copy of the selection file, inform nnn to clear the selection and then do the subsequent processing with the tmp file.
A paged [|] or GUI [&] cmd run as plugin cannot clear selection.

The ctxcode indicates the context to change the active directory of.

The opcode indicates the operation type.

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. To skip this and choose the current context, set the CUR_CTX variable in .nnn-plugin-helper (or in the specific plugin after sourcing .nnn-plugin-helper) to 1.
Usage examples can be found in the Examples section below.

Get notified on file hover

If NNN_FIFO is set, nnn will open it and write every hovered files. This can be used in plugins and external scripts, e.g. to implement file previews.

Don't forget to fork in the background to avoid blocking nnn.

For more details on configuration and usage of the preview plugins, visit Live Previews.

Examples Copy Chapter

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.

#!/usr/bin/env sh

git log -p -- "$1"

Change to directory in clipboard using helper script

#!/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)

#!/usr/bin/env sh

. $(dirname $0)/.nnn-plugin-helper

nnn_cd "$(dirname $(readlink -fn $1))" 0

Change to arbitrary directory without helper script

#!/usr/bin/env sh

printf "cd to: "
read -r dir

printf "%s" "0c$dir" > "$NNN_PIPE"

Send every hovered file to X selection

#!/usr/bin/env sh

if [ -z "$NNN_FIFO" ] ; then
    exit 1
fi

while read FILE ; do
    printf "%s" "$FILE" | xsel
done < "$NNN_FIFO" &
disown

Quick `find` the first match in subtree and open in `nuke`

#!/usr/bin/env sh

NUKE="${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins/nuke"

printf "file name: "
read -r pattern

entry=$(find . -type f -iname "$pattern" -print -quit 2>/dev/null)

if [ -n "$entry" ]; then
    "$NUKE" "$entry"
fi

Quick find (using `fd`)

#!/usr/bin/env sh

. "$(dirname "$0")"/.nnn-plugin-helper

printf "pattern: "
read -r pattern

if [ -n "$pattern" ]; then
    printf "%s" "+l" > "$NNN_PIPE"
    eval "fd -HI $pattern -0" > "$NNN_PIPE"
fi

Quick grep (using `rg`)

#!/usr/bin/env sh

. "$(dirname "$0")"/.nnn-plugin-helper

printf "pattern: "
read -r pattern

if [ -n "$pattern" ]; then
    printf "%s" "+l" > "$NNN_PIPE"
    eval "rg -l0 --hidden -S $pattern" > "$NNN_PIPE"
fi

Change directory

NNN_PLUG='c:!read -p "full path: " -r to && [ -n "$to" ] && printf "0c%s" "${to}" > "$NNN_PIPE"*'

Contributing plugins Copy Chapter

1. Add informative sections like Description, Notes, Dependencies, Shell, Author etc. in the plugin.
2. Add an entry in the table above. Note that the list is alphabetically ordered by plugin name.
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.
5. If your plugin stores data, use ${XDG_CACHE_HOME:-$HOME/.cache}/nnn. Document it in-file.