nnn README

The project's README from github.com/jarun/nnn. As one markdown file: README.md.

nnn
nnn - Supercharge your productivity!

Latest release Availability Circle CI Status GitHub CI Status Privacy Awareness License

[Features] $~~$ [Quickstart] $~~$ [Plugins] $~~$ [Wiki]

nnn (n³) is a full-featured terminal file manager. It's tiny (~150 KiB), nearly 0-config and incredibly fast.

It is designed to be unobtrusive with smart workflows to match the trains of thought.

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, (un)mount disks, find & list, file/dir diff, upload files. A patch framework hosts sizable user-submitted patches which are subjective in nature.

Independent (neo)vim plugins - nnn.vim, vim-floaterm nnn wrapper and nnn.nvim (neovim exclusive).

Runs on the Pi, Termux (Android), Linux, macOS, BSD, Haiku, Cygwin, WSL, across DEs or a strictly CLI env.

(more use cases)

Live demo by Demoshell

Features

Quickstart

Beginners

  1. Install nnn, preferbly using the package manager.
  2. Run the following command to generate (and optionally add to your rc file) a shell function to start with.
    sh -c "$(curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/misc/quickstart.sh)"
    

Use the shell function name you chose to run nnn with your preferred configuration.

Power users

  1. Install nnn and the dependencies you need.
  2. Install plugins.
  3. Configure cd on quit.
  4. The desktop opener is default. Use -e to open text files in the terminal. Optionally open detached.
  5. In a CLI environment, set NNN_OPENER to nuke. Use option -c. For GUI apps, consider xopen.
  6. Sync subshell $PWD to nnn.
  7. Use -x to sync selection to clipboard, show notis on cp, mv, rm and set xterm title.
  8. Bid ls goodbye! alias l='nnn -dDe' :sunglasses:
  9. Visit the Live previews and Troubleshooting Wiki pages.

Don't memorize! Arrows, /, q suffice. Tab creates and/or cycles contexts. ? lists shortcuts.

Wiki

Videos

Elsewhere

Developers

Visit the Tracker thread for a list of features in progress and anything up for grabs. Feel free to discuss new ideas or enhancement requests.

nnn (jarun/nnn)

vim
Searching Database…

22.1K ·GitHub
What is this?nnn (n3) is a terminal file manager built for speed and low resource use. The binary is typically around 100KB, it usually needs less than 3.5MB of resident memory, and it runs fine even with 8 colors.
Is it a full file manager or just a directory browser?A full one: create, rename, duplicate, copy, move, delete, archive and link files, batch-rename a whole selection, and send deletions to the FreeDesktop-compliant trash. It also doubles as a disk usage analyzer.
How do I get it running?Install via your package manager (it is widely packaged) and run the quickstart command to generate a shell function, or just run the static binary with no install at all. After that, arrows, / and q are enough to get around.
Do I need to install anything else for the fancier features?The core has minimal library dependencies and is easy to compile; extras are opt-in. Remote mounts need sshfs or rclone, rich previews come from FIFO-based plugins, and files open through your desktop opener (or nuke in a pure CLI setup).
Is there a config file I need to learn?None to set up - there is no config file, just sensible defaults, and a plugin can back up your settings. Deeper customization happens at compile time, where features and dependencies can be compiled in or out.
Does it only work on desktop Linux?No - it targets any POSIX terminal: Linux, macOS and the BSDs, WSL on Windows, Raspberry Pi, and Android via Termux. Shortcuts are touch-friendly for handhelds, and there is a 1-column mode for small screens.
Does it collect any data about me?No. It is explicitly privacy-aware with no unconfirmed user data collection - everything stays local in your terminal.
How does search work?Filtering is instant as you type, in three modes: plain string (default), fuzzy and regex (POSIX/PCRE2). A unique match jumps straight into the matching directory, and a subtree search plugin can open or edit every result.
Can I preview files before opening them?Yes - text files and directories have a built-in previewer, FIFO-based plugins extend previews to many other mime types, and a plugin adds image, video and audio thumbnails. Archives can be listed, extracted or mounted via FUSE.
What are contexts?They are nnn's take on tabs or workspaces, each with its own custom color; Tab creates and cycles them. Alongside them you get sessions, bookmarks and a mark-and-visit system for directories.
Can I hook it into my other tools?Yes - plugins are language-agnostic and can be run with hotkeys, nnn works as a file picker and ships a (neo)vim plugin, and cd-on-quit plus stdin path lists make shell integration easy. Power users alias things like l='nnn -dDe'.
What are similar projects?yazi, ranger, neovim, SpaceVim, nerdtree, tig, glances, superfile
Creator
jarun
Size
7.8 MB
Stars
22.1K
Age
10y
Commits · 90 Days