<a href="https://github.com/jarun/nnn/blob/master/LICENSE"><img src="https://img.shields.io/badge/©-BSD%202--Clause-important.svg?maxAge=2592000" alt="License" /></a>
</p>
-<p align="center"><a href="https://asciinema.org/a/353811"><img src="https://i.imgur.com/InHB5DB.png" /></a></p>
-<p align="center"><i>icons and colors asciicast</i></p>
+<p align="center"><a href="http://i.imgur.com/kOld6HT.gif"><img src="https://i.imgur.com/NUsSA2u.jpg"></a></p>
<h3 align="center">[<a
href="https://github.com/jarun/nnn#features">Features</a>] [<a
href="https://github.com/jarun/nnn#quickstart">Quickstart</a>] [<a
href="https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins">Plugins</a>] [<a
-href="https://github.com/jarun/nnn/wiki">Documentation</a>]</h3>
+href="https://github.com/jarun/nnn/wiki">Wiki</a>]</h3>
-<br>
+`nnn` (_n³_) is a full-featured terminal file manager. It's tiny, nearly 0-config and [incredibly fast](https://github.com/jarun/nnn/wiki/Performance).
-[](https://www.youtube.com/embed/-knZwdd1ScU)
-
-<br>
+It is designed to be unobtrusive with smart workflows to match the trains of thought.
-`nnn` (_n³_) is a full-featured terminal file manager. It's tiny and nearly 0-config with an [incredible speed](https://github.com/jarun/nnn/wiki/Performance).
+`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](https://github.com/jarun/nnn/wiki/Live-previews), (un)mount disks, find & list, file/dir diff, upload files. A [patch framework](https://github.com/jarun/nnn/tree/master/patches) hosts sizable user-submitted patches which are subjective in nature.
-It is designed to be unobtrusive with smart workflows to match the trains of thought.
+Independent (neo)vim plugins - [nnn.vim](https://github.com/mcchrish/nnn.vim), [vim-floaterm nnn wrapper](https://github.com/voldikss/vim-floaterm#nnn) and [nnn.nvim](https://github.com/luukvbaal/nnn.nvim) (neovim exclusive).
-`nnn` can analyze disk usage, batch rename, launch apps and pick files. The plugin repository has tons of plugins and documentation to extend the capabilities further e.g. [preview](https://github.com/jarun/nnn/wiki/Live-previews), (un)mount disks, find & list, file/dir diff, upload files.
-
-There are 2 independent (neo)vim plugins - [nnn.vim](https://github.com/mcchrish/nnn.vim) and [vim-floaterm nnn wrapper](https://github.com/voldikss/vim-floaterm#nnn).
-
-It runs smoothly on the Pi, [Termux](https://www.youtube.com/embed/AbaauM7gUJw) (Android), Linux, macOS, BSD, Haiku, Cygwin, WSL, across DEs and GUI utilities or a strictly CLI environment.
-
-<details><summary><i><b>Expand</b></i> for some nnn magic! :dark_sunglasses:</summary><br><ul>
- <li>Instantly load, sort, filter thousands of files</li>
- <li>Type to navigate with automatic dir selection</li>
- <li>List input stream and pick entries to stdout or file</li>
- <li>find/fd/grep/ripgrep/fzf from nnn and list in nnn</li>
- <li> Never lose context - start where you quit</li>
- <li>Mount any cloud storage service in a few keypresses</li>
- <li>Select files from anywhere (not just a single dir)</li>
- <li>Unlimited bookmarks, plugins, cmds with custom hotkeys</li>
- <li>Write a plugin in any language you know</li>
- <li>Edit and preview markdown, man page, html</li>
- <li>Open a file and auto-advance to the next</li>
- <li>Filter filtered entries, export list of visible files</li>
- <li>Configure the middle mouse click to do anything</li>
- <li>Fuzzy search subtree and open a file (or its parent dir)</li>
- <li>Load four dirs with custom settings at once</li>
- <li>Notifications on cp, mv, rm completion</li>
- <li>Auto-sync selection to system clipboard</li>
- <li>Access selection from another instance of nnn</li>
- <li>Open text files detached in another pane/tab/window</li>
- <li>Mount and modify archives</li>
- <li>Create files/dirs/duplicates with parents (like <i>mkdir -p</i>)</li>
- <li>Toggle hidden with <kbd>.</kbd>, visit HOME with <kbd>~</kbd>, last dir with <kbd>-</kbd></li>
- <li>Mark a frequently visited dir at runtime</li>
- <li>Sort by modification, access and inode change time</li>
- <li>Compile out/in features with make variables</li>
- <li>Watch matrix text fly or read fortune messages</li>
- <li>Configure in 5 minutes!</li>
-</ul></details>
+Runs on the Pi, [Termux](https://www.youtube.com/embed/AbaauM7gUJw) (Android), Linux, macOS, BSD, Haiku, Cygwin, WSL, across DEs or a strictly CLI env.
-<p align="center">
-<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://img.shields.io/badge/donate-@PayPal-1eb0fc.svg" alt="Donate via PayPal!" /></a>
-</p>
+[_(there's more)_](https://github.com/jarun/nnn/wiki/Basic-use-cases#the_nnn-magic)
## Features
+- 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)
- No config file, minimal config with sensible defaults
- Plugin to backup configuration
- Widely available on many packagers
- - Touch enabled, comfortable on handhelds too!
+ - Touch enabled, handheld-friendly shortcuts
- Unicode support
-- Quality
- - Privacy-aware (no unconfirmed user data collection)
- - POSIX-compliant, follows Linux kernel coding style
- - Highly optimized, static analysis integrated code
- Modes
- Light (default), detail
- Disk usage analyzer (block/apparent)
- File picker, (neo)vim plugin
- Navigation
- - *Type-to-nav* mode with dir auto-select
+ - Filter with automatic dir entry on unique match
+ - *Type-to-nav* (turbo navigation/always filter) mode
- Contexts (_aka_ tabs/workspaces) with custom colors
- - Sessions, bookmarks with hotkeys; mark and visit a dir
- - Remote mounts (needs sshfs, rclone)
+ - Sessions, bookmarks, mark and visit a dir
+ - Remote mounts (needs `sshfs`, `rclone`)
- Familiar shortcuts (arrows, <kbd>~</kbd>, <kbd>-</kbd>, <kbd>@</kbd>), quick look-up
- - CD on quit (*easy* shell integration)
- - Auto-advance on opening files
+ - `cd` on quit (*easy* shell integration)
+ - Proceed to next file on file open and selection
- Search
- Instant filtering with *search-as-you-type*
- Regex (POSIX/PCRE) and string (default) filters
- Subtree search plugin to open or edit files
- Sort
- - Ordered pure numeric names by default (visit _/proc_)
+ - 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
- Preview hovered files in FIFO-based previewer
- Open with desktop opener or specify a custom opener
- File-specific colors (or minimal _dirs in context color_)
- - Icons (customize and compile-in)
- - Plugins for image and video thumbnails
- - Create, list, extract, mount (FUSE based) archives
- - Option to open all text files in EDITOR
-- Information
- - Detailed file information
- - Media information plugin
+ - 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 (needs trash-cli)
+ - 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
- - Display file list from stdin or plugin
+ - List input stream of file paths from stdin or plugin
- Copy (as), move (as), delete, archive, link selection
- - Dir updates, notification on cp, mv, rm completion
+ - Dir updates, notification on `cp`, `mv`, `rm` completion
- Copy file paths to system clipboard on select
- - Create (with parents), rename, duplicate files and dirs
- Launch apps, run commands, spawn a shell, toggle exe
- - Hovered file set as `$nnn` at prompt and spawned shell
+ - 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
-1. [Install](https://github.com/jarun/nnn/wiki/Usage) `nnn` and any dependecies you need. All files are opened with the desktop opener by default.
-2. Add option `-e` to your alias to open text files in `$VISUAL`/`$EDITOR`/ vi. [Open detached](https://github.com/jarun/nnn/wiki/Basic-use-cases#detached-text) if you wish.
-3. Configure [cd on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit).
-4. [Install plugins](https://github.com/jarun/nnn/tree/master/plugins#installation).
-5. Use option `-x` to copy selected file paths to system clipboard and show notis on cp, mv, rm completion.
-6. For a CLI-only environment, customize and use plugin [`nuke`](https://github.com/jarun/nnn/blob/master/plugins/nuke) with option `-c` (overrides `-e`).
-7. Bid _ls_ goodbye! `alias ls='nnn -de'` :sunglasses:
+1. [Install](https://github.com/jarun/nnn/wiki/Usage) `nnn` and the dependencies you need.
+2. The desktop opener is default. Use `-e` to open text files in the terminal. Optionally [open detached](https://github.com/jarun/nnn/wiki/Basic-use-cases#detached-text).
+3. Configure [`cd` on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit).
+4. [Sync subshell `$PWD`](https://github.com/jarun/nnn/wiki/Basic-use-cases#sync-subshell-pwd) to `nnn`.
+5. [Install plugins](https://github.com/jarun/nnn/tree/master/plugins#installation).
+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`](https://github.com/jarun/nnn/wiki/Usage#configuration) to [`nuke`](https://github.com/jarun/nnn/blob/master/plugins/nuke). Use option `-c`.
+8. Bid `ls` goodbye! `alias ls='nnn -de'` :sunglasses:
+9. Visit the [Live previews](https://github.com/jarun/nnn/wiki/Live-previews) and [Troubleshooting](https://github.com/jarun/nnn/wiki/Troubleshooting) Wiki pages.
+
+Don't memorize! Arrows, <kbd>/</kbd>, <kbd>q</kbd> suffice. <kbd>Tab</kbd> creates and/or cycles contexts. <kbd>?</kbd> lists shortcuts.
-Don't memorize! Arrows (or <kbd>h</kbd> <kbd>j</kbd> <kbd>k</kbd> <kbd>l</kbd>), <kbd>/</kbd>, <kbd>q</kbd> suffice. <kbd>Tab</kbd> creates, cycles contexts. <kbd>?</kbd> lists shortcuts.
+[](https://www.youtube.com/embed/-knZwdd1ScU)
[](https://github.com/jarun/nnn/wiki)
## Elsewhere
+- [AddictiveTips](https://www.addictivetips.com/ubuntu-linux-tips/navigate-linux-filesystem/)
- [ArchWiki](https://wiki.archlinux.org/index.php/Nnn)
- [FOSSMint](https://www.fossmint.com/nnn-linux-terminal-file-browser/)
- [gHacks Tech News](https://www.ghacks.net/2019/11/01/nnn-is-an-excellent-command-line-based-file-manager-for-linux-macos-and-bsds/)
- Hacker News [[1](https://news.ycombinator.com/item?id=18520898)] [[2](https://news.ycombinator.com/item?id=19850656)]
- [It's FOSS](https://itsfoss.com/nnn-file-browser-linux/)
+- [Linux Format Issue 265; Manage files with nnn](https://linuxformat.com/archives?issue=265)
- LinuxLinks [[1](https://www.linuxlinks.com/nnn-fast-and-flexible-file-manager/)] [[2](https://www.linuxlinks.com/bestconsolefilemanagers/)] [[3](https://www.linuxlinks.com/excellent-system-tools-nnn-portable-terminal-file-manager/)]
+- [Linux Magazine; FOSSPicks](https://www.linux-magazine.com/Issues/2017/205/FOSSPicks/(offset)/15)
+- [Make Tech Easier](https://www.maketecheasier.com/nnn-file-manager-terminal/)
+- [Opensource.com](https://opensource.com/article/22/12/linux-file-manager-nnn)
- [Open Source For You](https://www.opensourceforu.com/2019/12/nnn-this-feature-rich-terminal-file-manager-will-enhance-your-productivity/)
+- [PCLinuxOS Magazine Issue June 2021](https://pclosmag.com/html/Issues/202106/page08.html)
- [Suckless Rocks](https://suckless.org/rocks/)
-- [Ubuntu Full Circle Magazine - Issue 135](https://fullcirclemagazine.org/issue-135/)
+- [Ubuntu Full Circle Magazine Issue 135; Review: nnn](https://fullcirclemagazine.org/issue-135/)
+- [Using and Administering Linux: Volume 2: Zero to SysAdmin: Advanced Topics](https://books.google.com/books?id=MqjDDwAAQBAJ&pg=PA32)
- [Wikipedia](https://en.wikipedia.org/wiki/Nnn_(file_manager))
## Developers
-- [Arun Prakash Jana](https://github.com/jarun) (Copyright © 2016-2020)
+- [Arun Prakash Jana](https://github.com/jarun) (Copyright © 2016-2023)
- [0xACE](https://github.com/0xACE)
- [Anna Arad](https://github.com/annagrram)
- [KlzXS](https://github.com/KlzXS)
- [Léo Villeveygoux](https://github.com/leovilok)
-- [Maxim Baz](https://github.com/maximbaz)
-- [Todd Yamakawa](https://github.com/toddyamakawa)
+- [Luuk van Baal](https://github.com/luukvbaal)
+- [NRK](https://codeberg.org/NRK)
+- [Sijmen J. Mulder](https://github.com/sjmulder)
- and other contributors
-Visit the [ToDo list](https://github.com/jarun/nnn/issues/781) to contribute or see the features in progress.
+Visit the [Tracker](https://github.com/jarun/nnn/issues/1546) thread for a list of features in progress and anything up for grabs. Feel free to [discuss](https://github.com/jarun/nnn/discussions) new ideas or enhancement requests.