navi/docs/cheatsheet_repositories.md

Cheatsheet repositories

• Browsing through cheatsheet repositories
• Importing cheatsheets
• Adding your own cheatsheets
• Submitting cheatsheets
• Using cheatsheets from other tools

Browsing through cheatsheet repositories

You can find cheatsheet repositories with:

navi repo browse

Importing cheatsheets

You can import cheatsheets from any git repository that includes .cheat files:

navi repo add https://github.com/denisidoro/cheats

Adding your own cheatsheets

You can either start a git repo with cheatsheets and import it as described above or you can add them directly to data_dir/navi.

Submitting cheatsheets

The main repository for cheatsheets is denisidoro/cheats. Feel free to open a PR there for me to include your contributions.

In order to add your own repository as a featured cheatsheet repo, please edit this file. This list will be displayed when navi repo browse is run.

Using cheatsheets from other tools

You can use cheatsheets from tldr by running:

navi --tldr <query>

You can use cheatsheets from cheat.sh by running:

navi --cheatsh <query>