Mirrors/navi
1
0
Fork 0
mirror of https://github.com/denisidoro/navi.git synced 2026-01-23 02:14:19 +00:00
Code Issues Projects Releases Wiki Activity
navi/docs/README.md
alexis-opolka f9bc3d2e26 Moved a bit of information from the base README to the docs README 
Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>
2025-02-16 12:04:52 +01:00

2.7 KiB
Raw Blame History

Navi icon Actions Status GitHub release

Table of Contents

About

Navi is an interactive cheatsheet tool for the command-line.
It allows you to browse through cheatsheets (that you may write yourself or download from maintainers) and execute commands.

Demo

It uses fzf, skim, or Alfred under the hood and it can be either used as a command or as a shell widget (à la Ctrl-R).

Navi Pros

  • it will spare you from knowing CLIs by heart
  • it will spare you from copy-pasting output from intermediate commands
  • it will make you type less
  • it will teach you new one-liners

Similar tools

There are many similar projects out there (beavr, bro, cheat, cheat.sh, cmdmenu, eg, how2, howdoi, Command Line Interface Pages and tldr, to name a few).

They are excellent projects, but navi remains unique in the following ways:

  • it's natural to write cheatsheets tailored to your needs
  • arguments are neither hardcoded nor a simple template

Etymology

Navi is a character from The Legend of Zelda Ocarina of Time that provides Link with a variety of clues to help him solve puzzles and make progress in his quest.