What is this?
navi is an interactive cheatsheet tool for the command-line: you browse cheatsheets — written by you or downloaded from maintainers — and execute commands straight from them.
navi is an interactive cheatsheet tool for the command-line: you browse cheatsheets — written by you or downloaded from maintainers — and execute commands straight from them.Is it a library I import into my code, or a standalone app?A standalone interactive terminal app written in Rust, not a library. You can run it as a plain command, as a shell widget à la Ctrl-R, as a Tmux widget, as aliases, or as a shell scripting tool.
A standalone interactive terminal app written in Rust, not a library. You can run it as a plain command, as a shell widget à la Ctrl-R, as a Tmux widget, as aliases, or as a shell scripting tool.How do I get it onto my machine?Install it through a package manager; the README points to docs/installation for the exact commands.
Install it through a package manager; the README points to docs/installation for the exact commands.Does it need anything else installed to work?One dependency worth knowing: navi is built on fzf or skim — the fuzzy finders that power its interactive selection of commands.
One dependency worth knowing: navi is built on fzf or skim — the fuzzy finders that power its interactive selection of commands.Will it run on Linux, macOS and Windows alike?It's cross-platform: the repo packages it for Linux, macOS and Windows, and the Tmux widget mode works even inside SSH sessions on remote machines.
It's cross-platform: the repo packages it for Linux, macOS and Windows, and the Tmux widget mode works even inside SSH sessions on remote machines.What happens the first time I run it?It walks you through downloading and managing cheatsheets. By default they are stored at ~/.local/share/navi/cheats/.
It walks you through downloading and managing cheatsheets. By default they are stored at ~/.local/share/navi/cheats/.Do I have to write all the cheatsheets myself?No — you can browse featured cheatsheets, import them from git repositories, reuse cheatsheets from tldr and cheat.sh, write and share your own, auto-update repositories, and even auto-export them from your TiddlyWiki notes via a plugin.
No — you can browse featured cheatsheets, import them from git repositories, reuse cheatsheets from tldr and cheat.sh, write and share your own, auto-update repositories, and even auto-export them from your TiddlyWiki notes via a plugin.What does a cheatsheet file look like?Cheatsheets are plain .cheat files with a simple syntax; the full syntax and examples are documented in the repo's docs.
Cheatsheets are plain .cheat files with a simple syntax; the full syntax and examples are documented in the repo's docs.Why use this instead of just googling commands?Per its README, navi spares you from knowing CLIs by heart, saves you from copy-pasting output from intermediate commands, makes you type less, and teaches you new one-liners along the way.
Per its README, navi spares you from knowing CLIs by heart, saves you from copy-pasting output from intermediate commands, makes you type less, and teaches you new one-liners along the way.Which topics is it in?cheatsheets, snippets, fuzzy-search, scripting, interactive, cheatsheet, bash, tui, shell, customization, command-line, rust
cheatsheets, snippets, fuzzy-search, scripting, interactive, cheatsheet, bash, tui, shell, customization, command-line, rust