====== navi - cheatsheet tool for the command-line ======

{{https://raw.githubusercontent.com/denisidoro/navi/master/assets/icon.png}}

[[https://asciinema.org/a/406461|{{https://asciinema.org/a/406461.svg?400}}]]

Mit **''navi''** lassen sich Befehle zusammen mit Hinweise in **''.cheat'' ** Dateien aufschreiben. Diese werden mithilfe eines fuzzy finders übersichtlich in einem Menü dargestellt und zur Ausführung gebracht. Damit ist navi das perfekte Tool zum Merken von komplexen one-linern.

navi ist auch in der Lage externe Spickzettel Projekte wie [[https://tldr.sh|tldr.sh]] oder auch [[https://cheat.sh|cheat.sh]] abzufragen.

===== Installation =====

<WRAP tip> Nach der installation, sollte **navi als shell widget eingerichtet werden,** damit ausgeführte Befehle mit in die Shell History aufgenommen werden. Und auch eine nachträgliche Abänderung eines Befehls in der CLI möglich wird. </WRAP>
==== Arch Linux ====

[[aw>Install|Installiert]] das [[ap>navi]] Paket. Für die Shell Integration (**shell widget**) siehe [[https://github.com/denisidoro/navi/blob/master/docs/installation.md#installing-the-shell-widget|Installing the shell widget]]

===== Verwendung =====

<WRAP left square tip> Es ist zu empfehlen, beim **ersten Starten** von navi, **nicht das Standard Cheat Repo herunterzuladen**. Um überflüssige Befehlsansammlungen zu vermeiden. </WRAP>

  * navi wird durch Eingabe von ''navi''  gestartet (Keine Shell History Unterstützung)
  * Oder durch **''STRG+G'' **  (Wenn navi als Shell widget eingerichtet wurde, Shell History wird Unterstützung). Auf diese Art können Befehle vor dem Abschicken im CLI noch abgeändert werden.

==== Anlegen einer neuen Cheat Datei ====

=== Cheat Pfad ===

Das Standardablageverzeichnis für ''.cheat''  Dateien, erfährt man durch den Befehl:

<code bash>
❯ navi info cheats-path
/home/${USER}/.local/share/navi/cheats
</code>

=== Syntax ===

In ''.cheat''  Dateien können Variablen verwendet werden, dessen Inhalt von einem anderen Befehl befüllt werden. Dessen Ausgabe steht dann an den jeweiligen Stellen zur Auswahl im Menü bereit.
Dies ermöglicht es Cheats, mit sinnvollen Vorgabewerte zu belegen.

Für die Syntax siehe [[https://github.com/denisidoro/navi/blob/master/docs/cheatsheet_syntax.md|cheatsheet_syntax.md]]

=== Beispiel Cheats ===

Siehe hierzu [[:tools:cli:navi:navi_cheat_sammlung|]]

===== Tipps und Tricks =====

==== Befehlszeile als Suchbegriff verwenden ====

Wenn in der Befehlszeile bereits etwas eingegeben wurde (z.b. den Befehlsname) kann durch Drücken der Tastenkombination **''STRG+G''** der bereits eingegebene Teil der Befehlszeile als Suchbegriff in navi mit verwendet werden. Voraussetzung ist, dass als Schlagwort in der Cheat Datei der Befehlsname mit verwendet wurde.

<WRAP center square todo 60%> Hier sollte ein Beispiel mit passender Cheat Datei eingefügt werden. </WRAP>

===== siehe auch =====

  * [[navi_cheat_sammlung]]
  * [[https://github.com/denisidoro/navi|Projekt Homepage]]
  * [[https://archlinux.org/packages/extra/x86_64/navi/|Arch Paket Information]]
  * [[https://www.suletuxe.de/forum/index.php?board=18;action=display;threadid=816|Diskussionsthread im Suletuxe Forum]]