README.md

nav

nav is a hackable ncurses file manager, inspired by vim, ranger, and dvtm.

nav is a work in progress.

---

• Installation
• Image Display
• Clipboard
• Default Bindings
• Expansion Symbols
• Non Goals
• Future
• Contributing

What it has

• filemanager buffers
• w3mimgdisplay buffers
• embedded dvtm terminal
• async event-driven core
• fast and simple metadata (expansions)
• simple script language (Navscript)
• vim-style autocmds, marks, maps, syntax, colors
• multi-selection: move, remove, copy
• bulkrename
• directory jumplist
• file executor/opener with 'before/after' cmds.
• strong ctrlp-inspired autocomplete menu
• menu hint keys
• datatables (adhoc buffer content)
• buffer signaling with :pipe

Installation

Compiling from Source

Install dependencies:

• cmake
• ncurses
• pcre
• libtermkey
• libuv
• w3m (optional: image support)

$ cmake .
$ make
$ sudo make install

Image Display

With w3mimgdisplay installed

:new fm
:vnew img
:pipe #BUFFER_ID

:vnew img #BUFFER_ID

Clipboard

:set copy-pipe #SELECT_PROGRAM

example:

:set copy-pipe xclip -i

Default Bindings

See Wiki

Expansion Symbols

See Wiki

Non Goals

• text editor
• Navscript as a full-featured language

Future

• plugins
• dictionaries

Contributing

...is much welcome.