Back to Navi

Navi cheatsheets

docs/cheatsheet/README.md

2.24.02.0 KB
Original Source

Navi cheatsheets

<!-- TOC --> <!-- TOC -->

Working with cheatsheet repositories

Navi works best with what we call cheatsheet repositories, for more details see cheatsheet/repositories.

Manually adding cheatsheets to navi

If you don't want to work with cheatsheet repositories, you can manually add your cheatsheets to navi by putting them into the cheats_path of your platform.

You can find out your path using the info subcommands but a quick working command to go there would be:

  • Before 2.25.0

    bash
    cd $(navi info cheats-path)
    
  • After 2.25.0

    bash
    cd $(navi info default-cheats-path)
    

Choosing between queries and selection with variables

Navi lets you use different methods to fill a variable value, when prompted.

Keyboard keyPreference
<kbd> tab </kbd>The query is preferred
<kbd> enter </kbd>The selection is preferred

It means if you enter the <kbd> tab </kbd> key, navi will let you enter the value.

Using cheatsheets from other tools

[!WARNING] Navi DOESN'T SUPPORT as of now importing cheatsheets from other tools but is able to work with TLDR and Cheat.sh.

You can use cheatsheets from tldr by running:

sh
navi --tldr <query>

You can use cheatsheets from cheat.sh by running:

sh
navi --cheatsh <query>