nnn/README.md

nnn - type less, do more, wayyy faster

navigate-as-you-type & du (click to see demo video)

Introduction

nnn is a full-featured terminal file manager. It's tiny and nearly 0-config with an incredible performance.

nnn is also a du analyzer, an app launcher, a batch renamer and a file picker. The plugin repository has tons of plugins and documentation to extend the capabilities further. You can plug new functionality and play with a custom keybind instantly. There's an independent (neo)vim plugin.

It runs smoothly on the Raspberry Pi, Termux on Android, Linux, macOS, BSD, Cygwin, WSL and works seamlessly with DEs and GUI utilities.

Visit the Wiki for concepts, program usage, how-tos and troubleshooting.

Features

• Modes
  • Light (default), detail
  • Disk usage analyzer (block/apparent)
  • File picker, (neo)vim plugin
• Navigation
  • Navigate-as-you-type with dir auto-select
  • Contexts (aka tabs/workspaces) with custom colors
  • Sessions, bookmarks; pin and visit a dir
  • Remote mounts (needs sshfs, rclone)
  • Familiar shortcuts (arrows, ~, -, @), quick reference
  • CD on quit (easy shell integration)
• Sorting
  • Ordered pure numeric names by default (visit /proc)
  • Case-insensitive version (aka natural) sort
  • By file name, modification/access time, size, extension
• Search
  • Instant filtering with search-as-you-type
  • Regex and substring (default) matches
  • Subtree search to open or edit files (using plugin)
• Mimes
  • Open with desktop opener or specify a custom app
  • Create, list, extract, mount (FUSE based) archives
  • Option to open all text files in EDITOR
• Information
  • Detailed file information
  • Media information (using plugin)
• Convenience
  • Run plugins and commands with custom keybinds
  • FreeDesktop compliant trash (needs trash-cli)
  • Cross-dir file/all/range selection
  • Batch renamer (feature-limited) for selection or dir
  • Copy (as), move (as), delete, archive, link selection
  • Notification on cp, mv, rm completion
  • Copy file paths to system clipboard on select
  • Create (with parents), rename, duplicate (anywhere) files and dirs
  • Launch GUI apps, run commands, execute file, spawn a shell
  • Hovered file set as $nnn at prompt and spawned shell
  • Lock terminal (needs a locker)
• Privacy-aware (no unconfirmed user data collection)
• Minimal deps, minimal config (with sensible defaults)
• Widely available
• Unicode support
• Follows Linux kernel coding style
• Highly optimized, static analysis integrated code

Quickstart

1. Install the utilities you may need based on your regular workflows.
2. Configure cd on quit.
3. Optionally open all text files in $EDITOR (fallback vi): export NNN_USE_EDITOR=1.
4. For additional functionality install plugins.
5. To copy selected file paths to system clipboard and show notis on cp, mv, rm completion use option -x.
6. For a strictly CLI-only experience, see plugin nuke. It's a sample opener you can customize.

Don't memorize keys. Arrows (or h j k l), / and q suffice. Press ? to list shortcuts anytime.

Installation

Library dependencies

A curses library with wide char support (e.g. ncursesw), libreadline (optional) and standard libc.

Utility dependencies

Dependency	Installation	Operation
xdg-open (Linux), open(1) (macOS), cygstart (Cygwin)	base	desktop opener
file, coreutils (cp, mv, rm), xargs	base	file type, copy, move and remove
tar, (un)zip [atool/bsdtar for more formats]	base	create, list, extract tar, gzip, bzip2, zip
archivemount, fusermount(3)	optional	mount, unmount archives
sshfs, rclone, fusermount(3)	optional	mount, unmount remotes
trash-cli	optional	trash files (default action: rm)
vlock (Linux), bashlock (macOS), lock(1) (BSD)	optional	terminal locker (fallback: cmatrix)
advcpmv (Linux) (integration)	optional	copy, move progress
$VISUAL (else $EDITOR), $PAGER, $SHELL	optional	fallback vi, less, sh

From a package manager

Install nnn from your package manager. If the version available is dated try an alternative installation method.

Packaging status (expand)

Unlisted distros:

● CentOS (yum --enablerepo=epel install nnn)
● Milis Linux (mps kur nnn)
● NuTyX (cards install nnn)
● Source Mage (cast nnn)

Release packages

Packages for Arch Linux, CentOS, Debian, Fedora and Ubuntu are auto-generated with the latest stable release.

From source

Download the latest stable release or clone this repository (risky), install deps and compile. On Ubuntu 18.04:

$ sudo apt-get install pkg-config libncursesw5-dev libreadline-dev
$ sudo make strip install

To compile without libreadline:

$ sudo apt-get install pkg-config libncursesw5-dev
$ sudo make O_NORL=1 strip install

PREFIX is supported, in case you want to install to a different location.

See the developer guides for compilation notes on the Pi, Cygwin and other compilation modes.

Shell completion

Completion scripts for Bash, Fish and Zsh are available. Refer to your shell's manual for installation instructions.

Elsewhere

• Wikipedia
• ArchWiki
• FOSSMint
• gHacks Tech News
• Hacker News [1] [2]
• It's FOSS
• LinuxLinks [1] [2]
• Suckless Rocks
• Ubuntu Full Circle Magazine - Issue 135

Developers

• Arun Prakash Jana (Copyright © 2016-2019)
• 0xACE
• KlzXS
• and other contributors

nnn is actively developed. Visit the to the ToDo list to contribute or see the features in progress.