Navi

Navi is an interactive cheatsheet tool for helping with the command-line.

Installation

Navi is available on some package managers, see the github page for the list.
Otherwise, it is possible to install it manually.

• apt install fzf: fzf is a fuzzy finder, that is used by navi to perform searches.
• Go to the github project release page
• Download the archive `navi-{version}-x86_64-unknown-linux-musl.tar.gz
• Extract the archive
• Copy the navi executable somewhere in the PATH, (e.g. /usr/local/bin)
• Verify that navi is executable and has the correct owner

Bash widget

While navi can be run by simply executing navi, it can also be integrated to the shell for a better usage. See here

In order to enable the shell widget, add the following to your ~/.bashrc:

if command -v navi > /dev/null ; then
    eval "$(navi widget bash)"
fi

Navi can now be executed at any time by pressing Ctrl+G, and its search bar will be initialised by what is currently in the command-line.

Configuration

Navi can be configured by creating the configuration file ~/.config/navi/config.yaml. This path can also be retrieved by running navi info config-path.

See the example configuration file for the file's syntax and options.

Writing cheatsheets

Custom cheatsheets can be placed into the ~/.local/share/navi/cheats folder. Their name must end in .cheat.

The syntax specifications can be found here.

Downloading cheatsheets

Navi can download pre-made cheatsheets. See the github page for information.