2020-08-18 04:59:38 +00:00
< h3 align = "center" > < img src = "misc/logo/logo-128x128.png" alt = "nnn" > < br > nnn - < i > Supercharge your productivity!< / i > < / h3 >
2016-08-20 16:27:14 +00:00
2017-04-14 17:46:01 +00:00
< p align = "center" >
2020-08-18 04:59:38 +00:00
< a href = "https://github.com/jarun/nnn/releases/latest" > < img src = "https://img.shields.io/github/release/jarun/nnn.svg?maxAge=600&label=rel" alt = "Latest release" / > < / a >
< a href = "https://repology.org/project/nnn/versions" > < img src = "https://repology.org/badge/tiny-repos/nnn.svg?header=repos" alt = "Availability" > < / a >
2020-11-21 20:34:35 +00:00
< a href = "https://circleci.com/gh/jarun/workflows/nnn" > < img src = "https://img.shields.io/circleci/project/github/jarun/nnn.svg?label=circle%20ci" alt = "CircleCI Status" / > < / a >
< a href = "https://github.com/jarun/nnn/actions" > < img src = "https://github.com/jarun/nnn/workflows/ci/badge.svg?branch=master" alt = "GitHub CI Status" / > < / a >
2020-03-07 18:10:46 +00:00
< a href = "https://en.wikipedia.org/wiki/Privacy-invasive_software" > < img src = "https://img.shields.io/badge/privacy-✓-crimson?maxAge=2592000" alt = "Privacy Awareness" / > < / a >
2020-08-18 04:59:38 +00:00
< 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 >
2019-08-24 14:35:45 +00:00
< / p >
2021-04-25 04:07:08 +00:00
< p align = "center" > < a href = "http://i.imgur.com/kOld6HT.gif" > < img src = "https://i.imgur.com/NUsSA2u.jpg" > < / a > < / p >
2020-08-17 12:41:18 +00:00
2020-08-18 04:59:38 +00:00
< 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
2020-10-17 08:52:59 +00:00
href="https://github.com/jarun/nnn/wiki">Documentation< / a > ]< / h3 >
2019-07-29 23:27:59 +00:00
2020-10-17 08:52:59 +00:00
`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 ).
2020-09-06 09:08:11 +00:00
It is designed to be unobtrusive with smart workflows to match the trains of thought.
2020-05-01 15:56:56 +00:00
2021-06-04 23:18:34 +00:00
`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. [preview ](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.
2020-08-19 17:35:52 +00:00
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 ).
2019-08-14 14:27:44 +00:00
2020-10-01 11:14:37 +00:00
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.
2019-09-27 03:14:52 +00:00
2021-05-29 04:45:21 +00:00
[_(there's more)_ ](https://github.com/jarun/nnn/wiki/Basic-use-cases#the_nnn-magic )
2020-10-11 08:35:50 +00:00
2020-05-12 14:20:25 +00:00
< p align = "center" >
2020-10-12 12:00:17 +00:00
< 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 >
2020-05-12 14:20:25 +00:00
< / p >
2019-08-09 04:58:14 +00:00
## Features
2017-04-21 03:30:46 +00:00
2020-05-01 15:56:56 +00:00
- Frugal
2020-01-14 17:21:10 +00:00
- Typically needs less than 3.5MB resident memory
2020-08-02 10:48:35 +00:00
- Works with 8 colors (and xterm 256 colors)
2020-01-09 20:31:20 +00:00
- Disk-IO sensitive (few disk reads and writes)
2020-01-12 18:28:48 +00:00
- No FPU usage (all integer maths, even for file size)
2020-01-12 18:03:42 +00:00
- Minimizes screen refresh with fast line redraws
2020-08-08 04:46:11 +00:00
- Tiny binary (typically around 100KB)
2020-08-09 21:49:31 +00:00
- 1-column mode for smaller terminals and form factors
2020-08-18 04:59:38 +00:00
- Hackable - compile in/out features and dependencies
2020-01-10 14:13:37 +00:00
- Portable
2020-01-16 14:49:21 +00:00
- Language-agnostic plugins
2020-08-08 04:46:11 +00:00
- Static binary available (no need to install)
2020-02-15 01:55:18 +00:00
- Minimal library deps, easy to compile
2020-01-10 14:13:37 +00:00
- No config file, minimal config with sensible defaults
2020-09-06 00:22:25 +00:00
- Plugin to backup configuration
2020-01-10 14:13:37 +00:00
- Widely available on many packagers
2020-08-09 21:49:31 +00:00
- Touch enabled, comfortable on handhelds too!
2020-01-10 14:13:37 +00:00
- Unicode support
- Quality
- Privacy-aware (no unconfirmed user data collection)
- POSIX-compliant, follows Linux kernel coding style
- Highly optimized, static analysis integrated code
2018-11-11 17:50:16 +00:00
- Modes
2019-09-15 17:02:44 +00:00
- Light (default), detail
2019-03-22 23:27:21 +00:00
- Disk usage analyzer (block/apparent)
2019-03-24 16:31:15 +00:00
- File picker, (neo)vim plugin
2017-05-15 16:59:40 +00:00
- Navigation
2020-04-12 13:31:02 +00:00
- *Type-to-nav* mode with dir auto-select
2019-10-24 07:18:12 +00:00
- Contexts (_aka_ tabs/workspaces) with custom colors
2020-07-07 02:27:43 +00:00
- Sessions, bookmarks with hotkeys; mark and visit a dir
2021-03-16 10:34:09 +00:00
- Remote mounts (needs `sshfs` , `rclone` )
2020-08-08 04:46:11 +00:00
- Familiar shortcuts (arrows, < kbd > ~</ kbd > , < kbd > -</ kbd > , < kbd > @</ kbd > ), quick look-up
2021-03-16 10:34:09 +00:00
- `cd` on quit (*easy* shell integration)
2020-04-12 13:31:02 +00:00
- Auto-advance on opening files
2020-01-11 18:23:32 +00:00
- Search
- Instant filtering with *search-as-you-type*
2020-01-24 17:58:30 +00:00
- Regex (POSIX/PCRE) and string (default) filters
2020-01-11 18:23:32 +00:00
- Subtree search plugin to open or edit files
- Sort
2021-03-16 10:34:09 +00:00
- Ordered pure numeric names by default (visit `/proc` )
2019-06-16 13:26:11 +00:00
- Case-insensitive version (_aka_ natural) sort
2020-08-08 04:46:11 +00:00
- By name, access/change/mod (default) time, size, extn
2020-01-09 14:11:22 +00:00
- Reverse sort
2017-05-15 16:59:40 +00:00
- Mimes
2020-05-05 20:15:04 +00:00
- Preview hovered files in FIFO-based previewer
2020-08-17 08:35:15 +00:00
- Open with desktop opener or specify a custom opener
- File-specific colors (or minimal _dirs in context color_ )
2020-08-17 12:41:18 +00:00
- Icons (customize and compile-in)
2021-05-30 18:11:54 +00:00
- Plugin for image, video and audio thumbnails
2019-10-11 20:43:08 +00:00
- Create, list, extract, mount (FUSE based) archives
2021-03-16 10:34:09 +00:00
- Option to open all text files in `$EDITOR`
2017-05-15 16:59:40 +00:00
- Information
2019-04-30 03:06:55 +00:00
- Detailed file information
2020-01-11 18:23:32 +00:00
- Media information plugin
2017-05-15 16:59:40 +00:00
- Convenience
2020-01-07 16:42:39 +00:00
- Run plugins and custom commands with hotkeys
2021-05-10 15:24:04 +00:00
- FreeDesktop compliant trash utility integration
2019-10-24 01:26:15 +00:00
- Cross-dir file/all/range selection
2020-12-12 05:32:36 +00:00
- Create (with parents), rename, duplicate files and dirs
2020-03-11 12:22:38 +00:00
- Batch renamer for selection or dir
2020-12-12 14:32:46 +00:00
- List input stream of file paths from stdin or plugin
2019-10-14 22:17:57 +00:00
- Copy (as), move (as), delete, archive, link selection
2021-03-16 10:34:09 +00:00
- Dir updates, notification on `cp` , `mv` , `rm` completion
2019-12-12 14:21:08 +00:00
- Copy file paths to system clipboard on select
2020-08-08 04:46:11 +00:00
- Launch apps, run commands, spawn a shell, toggle exe
2020-12-12 05:32:36 +00:00
- Access hovered file as `$nnn` at prompt or spawned shell
2020-01-11 23:18:23 +00:00
- Lock terminal after configurable idle timeout
2020-06-14 05:45:41 +00:00
- Basic support for screen readers and braille displays
2017-03-29 05:33:22 +00:00
2019-09-26 00:16:06 +00:00
## Quickstart
2020-12-18 13:42:22 +00:00
1. [Install ](https://github.com/jarun/nnn/wiki/Usage ) `nnn` and any dependencies you need. All files are opened with the desktop opener by default.
2021-03-20 01:10:26 +00:00
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.
2021-03-16 10:34:09 +00:00
3. Configure [`cd` on quit ](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit ).
2021-02-28 18:25:49 +00:00
4. [Sync subshell `$PWD` ](https://github.com/jarun/nnn/wiki/Basic-use-cases#sync-subshell-pwd ) to `nnn` .
2021-02-27 18:45:11 +00:00
5. [Install plugins ](https://github.com/jarun/nnn/tree/master/plugins#installation ).
2021-04-16 18:48:34 +00:00
6. Use `-x` to sync selection to system clipboard, show notis on `cp` , `mv` , `rm` completion and set xterm title.
2021-02-27 18:45:11 +00:00
7. For a CLI-only environment, customize and use plugin [`nuke` ](https://github.com/jarun/nnn/blob/master/plugins/nuke ) with option `-c` (overrides `-e` ).
2021-03-16 10:34:09 +00:00
8. Bid `ls` goodbye! `alias ls='nnn -de'` :sunglasses:
2021-03-30 21:43:18 +00:00
9. Visit the [Live previews ](https://github.com/jarun/nnn/wiki/Live-previews ) and [Troubleshooting ](https://github.com/jarun/nnn/wiki/Troubleshooting ) Wiki pages.
2019-09-26 00:16:06 +00:00
2021-04-18 03:06:14 +00:00
Don't memorize! Arrows, < kbd > /< / kbd > , < kbd > q< / kbd > suffice. < kbd > Tab< / kbd > creates and/or cycles contexts. < kbd > ?< / kbd > lists shortcuts.
2019-09-26 00:16:06 +00:00
2021-05-09 03:03:00 +00:00
[](https://www.youtube.com/embed/-knZwdd1ScU)
2020-10-17 08:52:59 +00:00
[](https://github.com/jarun/nnn/wiki)
2020-05-01 15:56:56 +00:00
2020-12-05 17:03:09 +00:00
## Videos
2020-05-01 15:56:56 +00:00
2020-12-06 03:45:20 +00:00
- [nnn file manager on Termux (Android) ](https://www.youtube.com/embed/AbaauM7gUJw )
2020-12-05 17:03:09 +00:00
- [NNN File Manager ](https://www.youtube.com/embed/1QXU4XSqXNo )
2020-12-06 03:45:20 +00:00
- [This Week in Linux 114 - TuxDigital ](https://www.youtube.com/watch?v=5W9ja0DQjSY&t=2059s )
2020-12-05 17:03:09 +00:00
- [nnn file manager basics - Linux ](https://www.youtube.com/embed/il2Fm-KJJfM )
2020-12-06 03:45:20 +00:00
- [I'M GOING TO USE THE NNN FILE BROWSER! 😮 ](https://www.youtube.com/embed/U2n5aGqou9E )
- [NNN: Is This Terminal File Manager As Good As People Say? ](https://www.youtube.com/embed/KuJHo-aO_FA )
2020-12-05 17:03:09 +00:00
- [nnn - A File Manager (By Uoou, again.) ](https://www.youtube.com/embed/cnzuzcCPYsk )
2017-09-02 06:53:19 +00:00
2019-10-06 14:22:30 +00:00
## Elsewhere
2017-04-25 16:54:47 +00:00
2020-12-17 02:15:02 +00:00
- [AddictiveTips ](https://www.addictivetips.com/ubuntu-linux-tips/navigate-linux-filesystem/ )
2019-10-06 14:22:30 +00:00
- [ArchWiki ](https://wiki.archlinux.org/index.php/Nnn )
2017-04-25 16:54:47 +00:00
- [FOSSMint ](https://www.fossmint.com/nnn-linux-terminal-file-browser/ )
2019-11-11 21:31:53 +00:00
- [gHacks Tech News ](https://www.ghacks.net/2019/11/01/nnn-is-an-excellent-command-line-based-file-manager-for-linux-macos-and-bsds/ )
2019-09-29 04:18:51 +00:00
- Hacker News [[1 ](https://news.ycombinator.com/item?id=18520898 )] [[2 ](https://news.ycombinator.com/item?id=19850656 )]
2018-08-18 07:04:25 +00:00
- [It's FOSS ](https://itsfoss.com/nnn-file-browser-linux/ )
2021-01-01 15:24:22 +00:00
- [Linux Format Issue 265; Manage files with nnn ](https://linuxformat.com/archives?issue=265 )
2020-02-24 14:26:02 +00:00
- 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/ )]
2021-01-01 15:24:22 +00:00
- [Linux Magazine; FOSSPicks ](https://www.linux-magazine.com/Issues/2017/205/FOSSPicks/(offset )/15)
2020-12-17 02:15:02 +00:00
- [Make Tech Easier ](https://www.maketecheasier.com/nnn-file-manager-terminal/ )
2020-07-21 12:49:22 +00:00
- [Open Source For You ](https://www.opensourceforu.com/2019/12/nnn-this-feature-rich-terminal-file-manager-will-enhance-your-productivity/ )
2021-06-03 17:58:07 +00:00
- [PCLinuxOS Magazine Issue June 2021 ](https://pclosmag.com/html/Issues/202106/page08.html )
2019-01-02 06:31:21 +00:00
- [Suckless Rocks ](https://suckless.org/rocks/ )
2021-01-01 15:24:22 +00:00
- [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 )
2020-11-01 13:14:40 +00:00
- [Wikipedia ](https://en.wikipedia.org/wiki/Nnn_(file_manager ))
2020-09-29 18:59:27 +00:00
2020-12-05 17:03:09 +00:00
## Developers
2020-09-29 18:59:27 +00:00
2020-12-28 21:03:52 +00:00
- [Arun Prakash Jana ](https://github.com/jarun ) (Copyright © 2016-2021)
2020-12-05 17:03:09 +00:00
- [0xACE ](https://github.com/0xACE )
- [Anna Arad ](https://github.com/annagrram )
- [KlzXS ](https://github.com/KlzXS )
- [Léo Villeveygoux ](https://github.com/leovilok )
2021-03-30 03:40:53 +00:00
- [Sijmen J. Mulder ](https://github.com/sjmulder )
2020-12-05 17:03:09 +00:00
- and other contributors
2021-06-02 05:14:41 +00:00
Visit the [ToDo list ](https://github.com/jarun/nnn/issues/1040 ) to contribute or see the features in progress.
