nnn/README.md

191 lines
10 KiB
Markdown
Raw Normal View History

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>
<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-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>
</p>
<p align="center"><a href="https://asciinema.org/a/353811"><img src="https://i.imgur.com/InHB5DB.png" /></a></p>
2020-10-01 11:14:37 +00:00
<p align="center"><i>icons and colors asciicast</i></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-09-29 17:23:31 +00:00
<br>
2020-10-01 11:14:37 +00:00
[![](https://user-images.githubusercontent.com/324519/94587860-062d7a80-0238-11eb-99b1-a9c9f0c32ac2.png)](https://www.youtube.com/embed/-knZwdd1ScU)
2020-09-29 17:23:31 +00:00
<br>
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
2020-08-19 17:35:52 +00:00
`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).
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
2020-10-11 08:35:50 +00:00
<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>
2020-10-11 08:35:50 +00:00
<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>
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
- 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
- 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
2019-11-25 02:20:22 +00:00
- Remote mounts (needs sshfs, rclone)
- 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
- Search
- Instant filtering with *search-as-you-type*
- Regex (POSIX/PCRE) and string (default) filters
- 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_)
- Case-insensitive version (_aka_ natural) sort
- 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)
- 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
- 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
- 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
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-10-11 08:35:50 +00:00
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.
2020-05-31 04:45:34 +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.
3. Configure [cd on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit).
2020-08-17 08:35:15 +00:00
4. [Install plugins](https://github.com/jarun/nnn/tree/master/plugins#installation).
2020-02-29 13:35:34 +00:00
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`).
2020-10-22 18:35:12 +00:00
7. Bid _ls_ goodbye! `alias ls='nnn -de'` :sunglasses:
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-10-17 08:52:59 +00:00
[![Wiki](https://img.shields.io/badge/RTFM-nnn%20Wiki-important?maxAge=2592000)](https://github.com/jarun/nnn/wiki)
2020-05-01 15:56:56 +00:00
## 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-11-15 15:01:31 +00:00
Visit the [ToDo list](https://github.com/jarun/nnn/issues/781) 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/)]
- [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/)
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
## Videos
2020-10-01 11:14:37 +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-10-03 10:06:51 +00:00
- [This Week in Linux 114 - TuxDigital](https://www.youtube.com/watch?v=5W9ja0DQjSY&t=2059s)
2020-10-01 11:14:37 +00:00
- [NNN File Manager](https://www.youtube.com/embed/1QXU4XSqXNo)
2020-11-14 08:16:24 +00:00
- [nnn file manager basics - Linux](https://www.youtube.com/embed/il2Fm-KJJfM)
2020-10-01 11:14:37 +00:00
- [nnn file manager on Termux (Android)](https://www.youtube.com/embed/AbaauM7gUJw)
2020-10-03 10:06:51 +00:00
- [nnn - A File Manager (By Uoou, again.)](https://www.youtube.com/embed/cnzuzcCPYsk)