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
History
alexis-opolka 445f9be247 Merge branch 'new-docs' of github.com:alexis-opolka/navi into alexis-opolka-new-docs
2025-05-04 12:37:13 +02:00
..
cheatsheet Moves entries from the cheatsheet/repositories article to the usage/commands/repo article 2025-03-29 11:36:51 +01:00
configuration Did a bit of refactoring - Deleted the png file inside the repository 2025-05-04 11:00:43 +02:00
contributions Did a bit of refactoring - Deleted the png file inside the repository 2025-05-04 11:00:43 +02:00
deprecated/Alfred Update README.md 2025-02-06 09:16:49 +01:00
examples Refactored the configuration article 2025-03-29 12:09:21 +01:00
installation Fixes typos 2025-03-29 23:09:38 +01:00
usage Updates the docs 2025-04-30 22:06:38 +02:00
widgets Small update 2025-04-30 22:15:00 +02:00
navi_config.md Merge branch 'new-docs' of github.com:alexis-opolka/navi into alexis-opolka-new-docs 2025-05-04 12:37:13 +02:00
README.md Moved a bit of information from the base README to the docs README 2025-02-16 12:04:52 +01:00

README.md

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.