2020-05-01 22:55:42 +00:00
< h1 align = "center" > nnn - < i > supercharge your productivity!< / i > < / h1 >
2016-08-20 16:27:14 +00:00
2017-04-14 17:46:01 +00:00
< p align = "center" >
2020-01-20 03:08:20 +00:00
< a href = "https://github.com/jarun/nnn/releases/latest" > < img src = "https://img.shields.io/github/release/jarun/nnn.svg?maxAge=600" alt = "Latest release" / > < / a >
2020-03-24 03:48:04 +00:00
< a href = "https://repology.org/project/nnn/versions" > < img src = "https://repology.org/badge/tiny-repos/nnn.svg?header=in repos" alt = "Availability" > < / a >
2020-01-20 03:08:20 +00:00
< a href = "https://travis-ci.org/jarun/nnn" > < img src = "https://img.shields.io/travis/jarun/nnn/master.svg?label=travis" alt = "Travis Status" / > < / a >
< a href = "https://circleci.com/gh/jarun/workflows/nnn" > < img src = "https://img.shields.io/circleci/project/github/jarun/nnn.svg?label=circleci" alt = "CircleCI 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-06-14 05:45:41 +00:00
< a href = "https://github.com/jarun/nnn/blob/master/LICENSE" > < img src = "https://img.shields.io/badge/license-BSD%202--Clause-yellowgreen.svg?maxAge=2592000" alt = "License" / > < / a >
2019-08-24 14:35:45 +00:00
< / p >
2020-05-11 22:32:55 +00:00
< p align = "center" > < a href = "https://www.youtube.com/watch?v=U2n5aGqou9E" > < img src = "https://i.imgur.com/MPWpmos.png" / > < / a > < / p >
< p align = "center" > < i > type-to-nav & du (click to see demo video)< / i > < / p >
2016-08-21 12:07:18 +00:00
2019-08-09 04:58:14 +00:00
## Introduction
2019-07-29 23:27:59 +00:00
2020-05-01 15:56:56 +00:00
< img align = "left" src = "misc/logo/logo-128x128.png" >
2020-04-28 12:52:09 +00:00
`nnn` (or `n³` ) is a full-featured terminal file manager. It's tiny and nearly 0-config with an [incredible performance ](https://github.com/jarun/nnn/wiki/Performance ).
2019-07-29 23:27:59 +00:00
2020-08-15 16:04:23 +00:00
`nnn` can analyze disk usage, batch rename, launch apps and pick files. The [plugin repository ](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins ) 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's an independent [(neo)vim plugin ](https://github.com/mcchrish/nnn.vim ).
2019-08-14 14:27:44 +00:00
2020-04-03 14:13:33 +00:00
It runs smoothly on the Pi, [Termux ](https://www.youtube.com/watch?v=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
2020-05-12 14:20:25 +00:00
< 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 >
2020-04-10 13:02:28 +00:00
## Black magic! :dark_sunglasses:
2020-04-09 04:18:04 +00:00
2020-06-27 18:39:48 +00:00
- Instantly load, sort, filter thousands of files
2020-05-01 22:55:42 +00:00
- Type to navigate with automatic dir selection
2020-05-07 19:38:42 +00:00
- find/fd/grep/ripgrep/fzf from `nnn` and list in `nnn`
2020-08-06 03:26:33 +00:00
- Never lose context - start where you quit
2020-06-27 15:38:55 +00:00
- Mount any cloud storage service in a few keypresses
- Select files from anywhere (not just a single dir)
2020-05-07 19:38:42 +00:00
- Unlimited bookmarks, plugins, cmds with custom hotkeys
2020-05-01 22:55:42 +00:00
- Write a plugin in any language you know
2020-06-27 15:38:55 +00:00
- Edit and preview markdown, man page, html
- Open a file and auto-advance to the next
- Filter filtered entries
- Export (filtered) list of visible files
2020-05-01 22:55:42 +00:00
- Configure the middle mouse click to do anything
2020-05-06 05:49:39 +00:00
- Fuzzy search subtree and open a file (or its parent dir)
2020-05-01 22:55:42 +00:00
- Load four dirs with custom settings at once
- Notifications on cp, mv, rm completion
- Auto-sync selection to system clipboard
2020-06-27 15:38:55 +00:00
- Access selection from another instance of `nnn`
2020-05-01 22:55:42 +00:00
- Open text files detached in another pane/tab/window
2020-06-27 15:38:55 +00:00
- Mount and modify archives
2020-05-01 22:55:42 +00:00
- Create files/dirs/duplicates with parents (like `mkdir -p` )
- Toggle hidden with < kbd > .</ kbd > , visit HOME with < kbd > ~</ kbd > , last dir with < kbd > -</ kbd >
2020-07-07 02:27:43 +00:00
- Mark a frequently visited dir at runtime
2020-06-14 05:45:41 +00:00
- Sort by modification, access and inode change time
- Compile out/in features with make options
2020-05-01 22:55:42 +00:00
- Watch matrix text fly or read fortune messages
- Configure in 5 minutes!
2020-04-10 12:30:52 +00:00
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-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
- Compile in/out features with make variables
2020-01-10 14:13:37 +00:00
- No config file, minimal config with sensible defaults
- 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
2019-11-25 02:20:22 +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
2019-09-26 16:21:38 +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
2019-07-14 17:30:14 +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 19:03:46 +00:00
- Open with desktop opener or specify a custom opener
2020-05-05 20:15:04 +00:00
- Preview hovered files in FIFO-based previewer
2020-08-08 04:46:11 +00:00
- Plugins for image and video thumbnails
2019-10-11 20:43:08 +00:00
- Create, list, extract, mount (FUSE based) archives
2019-04-30 03:06:55 +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
2019-03-09 03:35:32 +00:00
- FreeDesktop compliant trash (needs trash-cli)
2019-10-24 01:26:15 +00:00
- Cross-dir file/all/range selection
2020-03-11 12:22:38 +00:00
- Batch renamer for selection or dir
2020-08-06 03:26:33 +00:00
- Display file list from stdin or plugin
2019-10-14 22:17:57 +00:00
- Copy (as), move (as), delete, archive, link selection
2020-01-22 20:19:04 +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
- Create (with parents), rename, duplicate files and dirs
- Launch apps, run commands, spawn a shell, toggle exe
2019-11-23 20:43:27 +00:00
- Hovered file set as `$nnn` at prompt and 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-05-31 04:45:34 +00:00
1. [Install ](https://github.com/jarun/nnn/wiki/Usage#installation ) `nnn` and deps (if you need any). 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 ).
2020-02-29 13:35:34 +00:00
4. [Install plugins ](https://github.com/jarun/nnn/tree/master/plugins#installing-plugins ).
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` ).
2019-09-26 00:16:06 +00:00
2020-01-12 08:35:33 +00:00
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.
2019-09-26 00:16:06 +00:00
2020-05-01 15:56:56 +00:00
[](https://github.com/jarun/nnn/wiki)
## Developers
- [Arun Prakash Jana ](https://github.com/jarun ) (Copyright © 2016-2020)
- [0xACE ](https://github.com/0xACE )
- [Anna Arad ](https://github.com/annagrram )
- [KlzXS ](https://github.com/KlzXS )
2020-05-06 05:12:29 +00:00
- [Léo Villeveygoux ](https://github.com/leovilok )
2020-05-01 15:56:56 +00:00
- [Maxim Baz ](https://github.com/maximbaz )
2020-05-06 05:12:29 +00:00
- [Todd Yamakawa ](https://github.com/toddyamakawa )
2020-05-01 15:56:56 +00:00
- and other contributors
2020-06-03 10:42:27 +00:00
Visit the [ToDo list ](https://github.com/jarun/nnn/issues/629 ) to contribute or see the features in progress.
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
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/ )
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/ )]
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/ )
2019-01-02 06:31:21 +00:00
- [Suckless Rocks ](https://suckless.org/rocks/ )
2018-08-18 07:04:25 +00:00
- [Ubuntu Full Circle Magazine - Issue 135 ](https://fullcirclemagazine.org/issue-135/ )
