mirror of
https://github.com/denisidoro/navi.git
synced 2026-01-23 02:14:19 +00:00
41 lines
2.7 KiB
Markdown
41 lines
2.7 KiB
Markdown
# Navi <img src="https://raw.githubusercontent.com/denisidoro/navi/master/assets/icon.png" alt="icon" height="28px"/> [](https://github.com/denisidoro/navi/actions) 
|
|
|
|
## Table of Contents
|
|
|
|
<!-- TOC -->
|
|
* [Navi <img src="https://raw.githubusercontent.com/denisidoro/navi/master/assets/icon.png" alt="icon" height="28px"/>  ](#navi-img-srchttpsrawgithubusercontentcomdenisidoronavimasterassetsiconpng-alticon-height28px--)
|
|
* [Table of Contents](#table-of-contents)
|
|
* [About](#about)
|
|
* [Navi Pros](#navi-pros)
|
|
* [Similar tools](#similar-tools)
|
|
* [Etymology](#etymology)
|
|
<!-- TOC -->
|
|
|
|
## 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.
|
|
|
|
[](https://asciinema.org/a/406461)
|
|
|
|
It uses [fzf](https://github.com/junegunn/fzf), [skim](https://github.com/lotabout/skim), or [Alfred](https://www.alfredapp.com/) 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](https://github.com/denisidoro/beavr), [bro](https://github.com/hubsmoke/bro), [cheat](https://github.com/cheat/cheat), [cheat.sh](https://github.com/chubin/cheat.sh), [cmdmenu](https://github.com/amacfie/cmdmenu), [eg](https://github.com/srsudar/eg), [how2](https://github.com/santinic/how2), [howdoi](https://github.com/gleitz/howdoi), [Command Line Interface Pages](https://github.com/command-line-interface-pages) and [tldr](https://github.com/tldr-pages/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](https://zelda.gamepedia.com/Navi) is a character from [The Legend of Zelda Ocarina of Time](https://zelda.gamepedia.com/Ocarina_of_Time) that provides [Link](https://zelda.gamepedia.com/Link) with a variety of clues to help him solve puzzles and make progress in his quest.
|