navi/docs/usage/commands/repo
alexis-opolka 1c2abfd8e8 Updates the docs
Signed-off-by: alexis-opolka <53085471+alexis-opolka@users.noreply.github.com>
2025-04-30 22:06:38 +02:00
..
README.md Updates the docs 2025-04-30 22:06:38 +02:00

The repo subcommands of navi

Commands Reference

Command Description
add Lets you import a cheatsheet repository
browser Lets you browse through a curated list of cheatsheet repositories

Browsing through cheatsheet repositories

Navi lets you browse featured GitHub repositories registered in @denisidoro/cheats/featured_repos.txt.

You can find them within navi with the following command:

navi repo browse

Importing cheatsheet repositories

You can import cheatsheet repositories using a working git-clone format.
This includes using an HTTPS URL or an SSH URI.

  • Import using HTTPS

    navi repo add https://github.com/denisidoro/cheats
    
  • Import using SSH

    navi repo add git@github.com:denisidoro/cheats
    

Caution

Despite $NAVI_PATH being set, it will not be used when installing cheat sheets directly via navi's own commands.
For example when running navi add repo <repo>, the default paths will still be used.

To avoid this, you may simply clone repos via a regular git clone command, directly into $NAVI_PATH.