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 678894c874
Update new-docs branch (#26) 
* Fix CI lint errors

* Run ci on pull requests

* Update powershell plugins metadata

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Tries to implement the call to

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Moves Navi plugin to its own repository

https://github.com/alexis-opolka/navi.plugin.pwsh
Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Adds a check to create the profile file if it doesn't exist

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Allow cheatsheet items with same descriptions

Prior to the refactor performed in
https://github.com/denisidoro/navi/pull/760, cheatsheet items could have
the same tags and the same description, but a different snippet, and
they would all be listed in the finder.

After the refactor, this behavior has changed and such items will now be
treated as non-unique.

There appears to be no requirement for item descriptions to
be distinct, so this patch restores the earlier behavior.

Fixes: https://github.com/denisidoro/navi/issues/951

Signed-off-by: Erik Gabriel Carrillo <ecarrillo@alumni.utexas.net>

* Revert "Moves Navi plugin to its own repository"

This reverts commit 2bb57a23b8.

* Update shell.rs

It should remove the need to put a "-" in the middle of the name. It's a bit impractical.

* Update shell.rs

Updated the link to the module.

* Create navi.plugin.psm1

Moves the file to the base folder, removed cmdlets handlers and related options. Still needs modifications.

* Improved vim syntax highlighting documentation

* Update navi pwsh plugin

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Integrates the shortcut key in the module definition

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Update powershell plugin definition and exports

Co-authored-by: KITAGAWA Yasutaka <kit494way@gmail.com>
Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Update Module exports

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Fixes powershell export

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Fixes the issue with unauthorized I/O redirection

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>

* Update cd.yml

---------

Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>
Signed-off-by: Erik Gabriel Carrillo <ecarrillo@alumni.utexas.net>
Co-authored-by: KITAGAWA Yasutaka <kit494way@gmail.com>
Co-authored-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
Co-authored-by: Denis Isidoro <denisidoro@users.noreply.github.com>
Co-authored-by: Rodinei Fagundes <rodinei.jf@gmail.com>
2025-03-24 03:25:10 +01:00
..
cheatsheet Fixes small typo 2025-03-24 03:20:45 +01:00
configuration Quick refactor 2025-03-24 01:54:22 +01:00
contributions Update the documentation for contributions 2025-02-15 21:27:28 +01:00
deprecated/Alfred Update README.md 2025-02-06 09:16:49 +01:00
examples Create configuration/config-example.yaml 2025-03-05 18:56:07 +01:00
installation Moved content from docs/installation to docs/installation/ 2025-02-06 09:09:06 +01:00
usage Quick refactor 2025-03-24 01:54:22 +01:00
widgets Update new-docs branch (#26) 2025-03-24 03:25:10 +01: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.