README.md (9845B)
1 <h3 align="center"><img src="misc/logo/logo-128x128.png" alt="nnn"><br>nnn - <i>Supercharge your productivity!</i></h3> 2 3 <p align="center"> 4 <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> 5 <a href="https://repology.org/project/nnn/versions"><img src="https://repology.org/badge/tiny-repos/nnn.svg?header=repos" alt="Availability"></a> 6 <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> 7 <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> 8 <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> 9 <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> 10 </p> 11 12 <p align="center"><a href="http://i.imgur.com/kOld6HT.gif"><img src="https://i.imgur.com/NUsSA2u.jpg"></a></p> 13 14 <h3 align="center">[<a 15 href="https://github.com/jarun/nnn#features">Features</a>] [<a 16 href="https://github.com/jarun/nnn#quickstart">Quickstart</a>] [<a 17 href="https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins">Plugins</a>] [<a 18 href="https://github.com/jarun/nnn/wiki">Wiki</a>]</h3> 19 20 `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). 21 22 It is designed to be unobtrusive with smart workflows to match the trains of thought. 23 24 `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. 25 26 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). 27 28 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. 29 30 [_(there's more)_](https://github.com/jarun/nnn/wiki/Basic-use-cases#the_nnn-magic) 31 32 ## Features 33 34 - Quality 35 - Privacy-aware (no unconfirmed user data collection) 36 - POSIX-compliant, follows Linux kernel coding style 37 - Highly optimized, static analysis integrated code 38 - Frugal 39 - Typically needs less than 3.5MB resident memory 40 - Works with 8 colors (and xterm 256 colors) 41 - Disk-IO sensitive (few disk reads and writes) 42 - No FPU usage (all integer maths, even for file size) 43 - Minimizes screen refresh with fast line redraws 44 - Tiny binary (typically around 100KB) 45 - 1-column mode for smaller terminals and form factors 46 - Hackable - compile in/out features and dependencies 47 - Portable 48 - Language-agnostic plugins 49 - Static binary available (no need to install) 50 - Minimal library deps, easy to compile 51 - No config file, minimal config with sensible defaults 52 - Plugin to backup configuration 53 - Widely available on many packagers 54 - Touch enabled, handheld-friendly shortcuts 55 - Unicode support 56 - Modes 57 - Light (default), detail 58 - Disk usage analyzer (block/apparent) 59 - File picker, (neo)vim plugin 60 - Navigation 61 - *Type-to-nav* mode with automatic matching dir entry 62 - Contexts (_aka_ tabs/workspaces) with custom colors 63 - Sessions, bookmarks with hotkeys; mark and visit a dir 64 - Remote mounts (needs `sshfs`, `rclone`) 65 - Familiar shortcuts (arrows, <kbd>~</kbd>, <kbd>-</kbd>, <kbd>@</kbd>), quick look-up 66 - `cd` on quit (*easy* shell integration) 67 - Auto-proceed on file open and selection 68 - Search 69 - Instant filtering with *search-as-you-type* 70 - Regex (POSIX/PCRE) and string (default) filters 71 - Subtree search plugin to open or edit files 72 - Sort 73 - Ordered pure numeric names by default (visit `/proc`) 74 - Case-insensitive version (_aka_ natural) sort 75 - By name, access/change/mod (default) time, size, extn 76 - Reverse sort 77 - Directory-specific ordering 78 - Mimes 79 - Preview hovered files in FIFO-based previewer 80 - Open with desktop opener or specify a custom opener 81 - File-specific colors (or minimal _dirs in context color_) 82 - Icons (customize and compile-in) 83 - Plugin for image, video and audio thumbnails 84 - Create, list, extract (to), mount (FUSE based) archives 85 - Option to open all text files in `$EDITOR` 86 - Convenience 87 - Detailed file stats and mime information 88 - Run plugins and custom commands with hotkeys 89 - FreeDesktop compliant trash utility integration 90 - Cross-dir file/all/range selection 91 - Create (with parents), rename, duplicate files and dirs 92 - Batch renamer for selection or dir 93 - List input stream of file paths from stdin or plugin 94 - Copy (as), move (as), delete, archive, link selection 95 - Dir updates, notification on `cp`, `mv`, `rm` completion 96 - Copy file paths to system clipboard on select 97 - Launch apps, run commands, spawn a shell, toggle exe 98 - Access context paths/files at prompt or spawned shell 99 - Lock terminal after configurable idle timeout 100 - Capture and show output of a program in help screen 101 - Basic support for screen readers and braille displays 102 103 ## Quickstart 104 105 1. [Install](https://github.com/jarun/nnn/wiki/Usage) `nnn` and the deps you need. 106 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). 107 3. Configure [`cd` on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit). 108 4. [Sync subshell `$PWD`](https://github.com/jarun/nnn/wiki/Basic-use-cases#sync-subshell-pwd) to `nnn`. 109 5. [Install plugins](https://github.com/jarun/nnn/tree/master/plugins#installation). 110 6. Use `-x` to sync selection to clipboard, show notis on `cp`, `mv`, `rm` and set xterm title. 111 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`. 112 8. Bid `ls` goodbye! `alias ls='nnn -de'` :sunglasses: 113 9. Visit the [Live previews](https://github.com/jarun/nnn/wiki/Live-previews) and [Troubleshooting](https://github.com/jarun/nnn/wiki/Troubleshooting) Wiki pages. 114 115 Don't memorize! Arrows, <kbd>/</kbd>, <kbd>q</kbd> suffice. <kbd>Tab</kbd> creates and/or cycles contexts. <kbd>?</kbd> lists shortcuts. 116 117 [![](https://i.imgur.com/TN3xYQz.jpg)](https://www.youtube.com/embed/-knZwdd1ScU) 118 119 [![Wiki](https://img.shields.io/badge/RTFM-nnn%20Wiki-important?maxAge=2592000)](https://github.com/jarun/nnn/wiki) 120 121 ## Videos 122 123 - [nnn file manager on Termux (Android)](https://www.youtube.com/embed/AbaauM7gUJw) 124 - [NNN File Manager](https://www.youtube.com/embed/1QXU4XSqXNo) 125 - [This Week in Linux 114 - TuxDigital](https://www.youtube.com/watch?v=5W9ja0DQjSY&t=2059s) 126 - [nnn file manager basics - Linux](https://www.youtube.com/embed/il2Fm-KJJfM) 127 - [I'M GOING TO USE THE NNN FILE BROWSER! 😮](https://www.youtube.com/embed/U2n5aGqou9E) 128 - [NNN: Is This Terminal File Manager As Good As People Say?](https://www.youtube.com/embed/KuJHo-aO_FA) 129 - [nnn - A File Manager (By Uoou, again.)](https://www.youtube.com/embed/cnzuzcCPYsk) 130 131 ## Elsewhere 132 133 - [AddictiveTips](https://www.addictivetips.com/ubuntu-linux-tips/navigate-linux-filesystem/) 134 - [ArchWiki](https://wiki.archlinux.org/index.php/Nnn) 135 - [FOSSMint](https://www.fossmint.com/nnn-linux-terminal-file-browser/) 136 - [gHacks Tech News](https://www.ghacks.net/2019/11/01/nnn-is-an-excellent-command-line-based-file-manager-for-linux-macos-and-bsds/) 137 - Hacker News [[1](https://news.ycombinator.com/item?id=18520898)] [[2](https://news.ycombinator.com/item?id=19850656)] 138 - [It's FOSS](https://itsfoss.com/nnn-file-browser-linux/) 139 - [Linux Format Issue 265; Manage files with nnn](https://linuxformat.com/archives?issue=265) 140 - 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/)] 141 - [Linux Magazine; FOSSPicks](https://www.linux-magazine.com/Issues/2017/205/FOSSPicks/(offset)/15) 142 - [Make Tech Easier](https://www.maketecheasier.com/nnn-file-manager-terminal/) 143 - [Open Source For You](https://www.opensourceforu.com/2019/12/nnn-this-feature-rich-terminal-file-manager-will-enhance-your-productivity/) 144 - [PCLinuxOS Magazine Issue June 2021](https://pclosmag.com/html/Issues/202106/page08.html) 145 - [Suckless Rocks](https://suckless.org/rocks/) 146 - [Ubuntu Full Circle Magazine Issue 135; Review: nnn](https://fullcirclemagazine.org/issue-135/) 147 - [Using and Administering Linux: Volume 2: Zero to SysAdmin: Advanced Topics](https://books.google.com/books?id=MqjDDwAAQBAJ&pg=PA32) 148 - [Wikipedia](https://en.wikipedia.org/wiki/Nnn_(file_manager)) 149 150 ## Developers 151 152 - [Arun Prakash Jana](https://github.com/jarun) (Copyright © 2016-2022) 153 - [0xACE](https://github.com/0xACE) 154 - [Anna Arad](https://github.com/annagrram) 155 - [KlzXS](https://github.com/KlzXS) 156 - [Léo Villeveygoux](https://github.com/leovilok) 157 - [Luuk van Baal](https://github.com/luukvbaal) 158 - [N-R-K](https://github.com/N-R-K) 159 - [Sijmen J. Mulder](https://github.com/sjmulder) 160 - and other contributors 161 162 Visit the [ToDo list](https://github.com/jarun/nnn/issues/1292) to contribute or see the features in progress.